# 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 DfareportingV2_1 # DCM/DFA Reporting And Trafficking API # # Manage your DoubleClick Campaign Manager ad campaigns and reports. # # @example # require 'google/apis/dfareporting_v2_1' # # Dfareporting = Google::Apis::DfareportingV2_1 # Alias the module # service = Dfareporting::DfareportingService.new # # @see https://developers.google.com/doubleclick-advertisers/reporting/ class DfareportingService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'dfareporting/v2.1/') end # Gets the account's active ad summary by account ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] summary_account_id # Account ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountActiveAdSummary] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountActiveAdSummary] # # @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_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::AccountActiveAdSummary::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountActiveAdSummary command.params['profileId'] = profile_id unless profile_id.nil? command.params['summaryAccountId'] = summary_account_id unless summary_account_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one account permission group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Account permission group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountPermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountPermissionGroup] # # @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_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountPermissionGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::AccountPermissionGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountPermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of account permission groups. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAccountPermissionGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAccountPermissionGroupsResponse] # # @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_account_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountPermissionGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAccountPermissionGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAccountPermissionGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one account permission by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Account permission ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountPermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountPermission] # # @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_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountPermissions/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::AccountPermission::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountPermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of account permissions. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAccountPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAccountPermissionsResponse] # # @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_account_permissions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountPermissions' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAccountPermissionsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAccountPermissionsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one account user profile by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # User profile ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountUserProfile] # # @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_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountUserProfiles/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new account user profile. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountUserProfile] # # @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 insert_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountUserProfiles' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of account user profiles, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active user profiles. # @param [Array, String] ids # Select only user profiles with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "user profile*2015" will return objects with names like "user # profile June 2015", "user profile April 2015", or simply "user profile 2015". # Most of the searches also add wildcards implicitly at the start and the end of # the search string. For example, a search string of "user profile" will match # objects with name "my user profile", "user profile 2015", or simply "user # profile". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] subaccount_id # Select only user profiles with the specified subaccount ID. # @param [String] user_role_id # Select only user profiles with the specified user role ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAccountUserProfilesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAccountUserProfilesResponse] # # @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_account_user_profiles(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, user_role_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountUserProfiles' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAccountUserProfilesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAccountUserProfilesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['userRoleId'] = user_role_id unless user_role_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing account user profile. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AccountUserProfile] account_user_profile_object # @param [String] id # User profile ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountUserProfile] # # @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_account_user_profile(profile_id, account_user_profile_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountUserProfiles' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing account user profile. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AccountUserProfile] # # @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 update_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accountUserProfiles' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_1::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_1::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one account by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Account ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Account] # # @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_account(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accounts/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Account::Representation command.response_class = Google::Apis::DfareportingV2_1::Account command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of accounts, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active accounts. Don't set this field to select both active and # non-active accounts. # @param [Array, String] ids # Select only accounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "account*2015" will return objects with names like "account June 2015" # , "account April 2015", or simply "account 2015". Most of the searches also # add wildcards implicitly at the start and the end of the search string. For # example, a search string of "account" will match objects with name "my account" # , "account 2015", or simply "account". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAccountsResponse] # # @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_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accounts' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAccountsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAccountsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing account. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Account] account_object # @param [String] id # Account ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Account] # # @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_account(profile_id, account_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accounts' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV2_1::Account::Representation command.response_class = Google::Apis::DfareportingV2_1::Account command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing account. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Account] # # @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 update_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/accounts' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV2_1::Account::Representation command.response_class = Google::Apis::DfareportingV2_1::Account command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one ad by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Ad ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Ad] # # @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_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/ads/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.response_class = Google::Apis::DfareportingV2_1::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new ad. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Ad] # # @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 insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/ads' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.response_class = Google::Apis::DfareportingV2_1::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of ads, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active ads. # @param [String] advertiser_id # Select only ads with this advertiser ID. # @param [Boolean] archived # Select only archived ads. # @param [Array, String] audience_segment_ids # Select only ads with these audience segment IDs. # @param [Array, String] campaign_ids # Select only ads with these campaign IDs. # @param [String] compatibility # Select default ads with the specified compatibility. Applicable when type is # AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on # desktop or on mobile devices for regular or interstitial ads, respectively. # APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO # refers to rendering an in-stream video ads developed with the VAST standard. # @param [Array, String] creative_ids # Select only ads with these creative IDs assigned. # @param [Array, String] creative_optimization_configuration_ids # Select only ads with these creative optimization configuration IDs. # @param [String] creative_type # Select only ads with the specified creativeType. # @param [Boolean] dynamic_click_tracker # Select only dynamic click trackers. Applicable when type is # AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, # select static click trackers. Leave unset to select both. # @param [Array, String] ids # Select only ads with these IDs. # @param [Array, String] landing_page_ids # Select only ads with these landing page IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] overridden_event_tag_id # Select only ads with this event tag override ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, String] placement_ids # Select only ads with these placement IDs assigned. # @param [Array, String] remarketing_list_ids # Select only ads whose list targeting expression use these remarketing list IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "ad*2015" will return objects with names like "ad June 2015", "ad # April 2015", or simply "ad 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "ad" will match objects with name "my ad", "ad 2015", or # simply "ad". # @param [Array, String] size_ids # Select only ads with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [Boolean] ssl_compliant # Select only ads that are SSL-compliant. # @param [Boolean] ssl_required # Select only ads that require SSL. # @param [Array, String] type # Select only ads with these types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAdsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAdsResponse] # # @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_ads(profile_id, active: nil, advertiser_id: nil, archived: nil, audience_segment_ids: nil, campaign_ids: nil, compatibility: nil, creative_ids: nil, creative_optimization_configuration_ids: nil, creative_type: nil, dynamic_click_tracker: nil, ids: nil, landing_page_ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, placement_ids: nil, remarketing_list_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, ssl_compliant: nil, ssl_required: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/ads' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAdsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAdsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['audienceSegmentIds'] = audience_segment_ids unless audience_segment_ids.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibility'] = compatibility unless compatibility.nil? command.query['creativeIds'] = creative_ids unless creative_ids.nil? command.query['creativeOptimizationConfigurationIds'] = creative_optimization_configuration_ids unless creative_optimization_configuration_ids.nil? command.query['creativeType'] = creative_type unless creative_type.nil? command.query['dynamicClickTracker'] = dynamic_click_tracker unless dynamic_click_tracker.nil? command.query['ids'] = ids unless ids.nil? command.query['landingPageIds'] = landing_page_ids unless landing_page_ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['remarketingListIds'] = remarketing_list_ids unless remarketing_list_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['sslCompliant'] = ssl_compliant unless ssl_compliant.nil? command.query['sslRequired'] = ssl_required unless ssl_required.nil? command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing ad. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Ad] ad_object # @param [String] id # Ad ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Ad] # # @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_ad(profile_id, ad_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/ads' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.response_class = Google::Apis::DfareportingV2_1::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing ad. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Ad] # # @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 update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/ads' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_1::Ad::Representation command.response_class = Google::Apis::DfareportingV2_1::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing advertiser group. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Advertiser group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one advertiser group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Advertiser group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AdvertiserGroup] # # @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_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new advertiser group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AdvertiserGroup] # # @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 insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of advertiser groups, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Select only advertiser groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # group June 2015", "advertiser group April 2015", or simply "advertiser group # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "advertisergroup" # will match objects with name "my advertisergroup", "advertisergroup 2015", or # simply "advertisergroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAdvertiserGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListAdvertiserGroupsResponse] # # @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_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAdvertiserGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAdvertiserGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing advertiser group. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AdvertiserGroup] advertiser_group_object # @param [String] id # Advertiser group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AdvertiserGroup] # # @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_group(profile_id, advertiser_group_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing advertiser group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::AdvertiserGroup] # # @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 update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertiserGroups' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_1::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one advertiser by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Advertiser ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertisers/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_1::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new advertiser. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertisers' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_1::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of advertisers, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_group_ids # Select only advertisers with these advertiser group IDs. # @param [Array, String] floodlight_configuration_ids # Select only advertisers with these floodlight configuration IDs. # @param [Array, String] ids # Select only advertisers with these IDs. # @param [Boolean] include_advertisers_without_groups_only # Select only advertisers which do not belong to any advertiser group. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Boolean] only_parent # Select only advertisers which use another advertiser's floodlight # configuration. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "advertiser" will match objects with # name "my advertiser", "advertiser 2015", or simply "advertiser". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] status # Select only advertisers with the specified status. # @param [String] subaccount_id # Select only advertisers with these subaccount IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListAdvertisersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertisers' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListAdvertisersResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListAdvertisersResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['floodlightConfigurationIds'] = floodlight_configuration_ids unless floodlight_configuration_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['includeAdvertisersWithoutGroupsOnly'] = include_advertisers_without_groups_only unless include_advertisers_without_groups_only.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['onlyParent'] = only_parent unless only_parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['status'] = status unless status.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing advertiser. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Advertiser] advertiser_object # @param [String] id # Advertiser ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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(profile_id, advertiser_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertisers' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_1::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing advertiser. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/advertisers' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_1::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_1::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of browsers. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListBrowsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListBrowsersResponse] # # @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_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/browsers' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListBrowsersResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListBrowsersResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Associates a creative with the specified campaign. This method creates a # default ad with dimensions matching the creative in the campaign if such a # default ad does not exist already. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Campaign ID in this association. # @param [Google::Apis::DfareportingV2_1::CampaignCreativeAssociation] campaign_creative_association_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CampaignCreativeAssociation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CampaignCreativeAssociation] # # @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 insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CampaignCreativeAssociation::Representation command.request_object = campaign_creative_association_object command.response_representation = Google::Apis::DfareportingV2_1::CampaignCreativeAssociation::Representation command.response_class = Google::Apis::DfareportingV2_1::CampaignCreativeAssociation command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of creative IDs associated with the specified campaign. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Campaign ID in this association. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCampaignCreativeAssociationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCampaignCreativeAssociationsResponse] # # @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_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCampaignCreativeAssociationsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCampaignCreativeAssociationsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one campaign by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Campaign ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_1::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new campaign. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Campaign] campaign_object # @param [String] default_landing_page_name # Default landing page name for this new campaign. Must be less than 256 # characters long. # @param [String] default_landing_page_url # Default landing page URL for this new campaign. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 insert_campaign(profile_id, campaign_object = nil, default_landing_page_name: nil, default_landing_page_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_1::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['defaultLandingPageName'] = default_landing_page_name unless default_landing_page_name.nil? command.query['defaultLandingPageUrl'] = default_landing_page_url unless default_landing_page_url.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of campaigns, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_group_ids # Select only campaigns whose advertisers belong to these advertiser groups. # @param [Array, String] advertiser_ids # Select only campaigns that belong to these advertisers. # @param [Boolean] archived # Select only archived campaigns. Don't set this field to select both archived # and non-archived campaigns. # @param [Boolean] at_least_one_optimization_activity # Select only campaigns that have at least one optimization activity. # @param [Array, String] excluded_ids # Exclude campaigns with these IDs. # @param [Array, String] ids # Select only campaigns with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] overridden_event_tag_id # Select only campaigns that have overridden this event tag ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For # example, "campaign*2015" will return campaigns with names like "campaign June # 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "campaign" will match campaigns with name "my # campaign", "campaign 2015", or simply "campaign". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] subaccount_id # Select only campaigns that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCampaignsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCampaignsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCampaignsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['atLeastOneOptimizationActivity'] = at_least_one_optimization_activity unless at_least_one_optimization_activity.nil? command.query['excludedIds'] = excluded_ids unless excluded_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing campaign. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Campaign] campaign_object # @param [String] id # Campaign ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_campaign(profile_id, campaign_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_1::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing campaign. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_1::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_1::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one change log by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Change log ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ChangeLog] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ChangeLog] # # @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_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/changeLogs/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ChangeLog::Representation command.response_class = Google::Apis::DfareportingV2_1::ChangeLog command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of change logs. # @param [String] profile_id # User profile ID associated with this request. # @param [String] action # Select only change logs with the specified action. # @param [Array, String] ids # Select only change logs with these IDs. # @param [String] max_change_time # Select only change logs whose change time is before the specified # maxChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] min_change_time # Select only change logs whose change time is before the specified # minChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Array, String] object_ids # Select only change logs with these object IDs. # @param [String] object_type # Select only change logs with the specified object type. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Select only change logs whose object ID, user name, old or new values match # the search string. # @param [Array, String] user_profile_ids # Select only change logs with these user profile IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListChangeLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListChangeLogsResponse] # # @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_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/changeLogs' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListChangeLogsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListChangeLogsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['action'] = action unless action.nil? command.query['ids'] = ids unless ids.nil? command.query['maxChangeTime'] = max_change_time unless max_change_time.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['minChangeTime'] = min_change_time unless min_change_time.nil? command.query['objectIds'] = object_ids unless object_ids.nil? command.query['objectType'] = object_type unless object_type.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['userProfileIds'] = user_profile_ids unless user_profile_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of cities, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] country_dart_ids # Select only cities from these countries. # @param [Array, String] dart_ids # Select only cities with these DART IDs. # @param [String] name_prefix # Select only cities with names starting with this prefix. # @param [Array, String] region_dart_ids # Select only cities from these regions. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCitiesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCitiesResponse] # # @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_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/cities' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCitiesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCitiesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['countryDartIds'] = country_dart_ids unless country_dart_ids.nil? command.query['dartIds'] = dart_ids unless dart_ids.nil? command.query['namePrefix'] = name_prefix unless name_prefix.nil? command.query['regionDartIds'] = region_dart_ids unless region_dart_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one connection type by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Connection type ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ConnectionType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ConnectionType] # # @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_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/connectionTypes/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ConnectionType::Representation command.response_class = Google::Apis::DfareportingV2_1::ConnectionType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of connection types. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListConnectionTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListConnectionTypesResponse] # # @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_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/connectionTypes' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListConnectionTypesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListConnectionTypesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing content category. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Content category ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one content category by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Content category ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ContentCategory] # # @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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_1::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new content category. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ContentCategory] # # @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 insert_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_1::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of content categories, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Select only content categories with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "contentcategory*2015" will return objects with names like " # contentcategory June 2015", "contentcategory April 2015", or simply " # contentcategory 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # contentcategory" will match objects with name "my contentcategory", " # contentcategory 2015", or simply "contentcategory". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListContentCategoriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListContentCategoriesResponse] # # @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_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListContentCategoriesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListContentCategoriesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing content category. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::ContentCategory] content_category_object # @param [String] id # Content category ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ContentCategory] # # @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_content_category(profile_id, content_category_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_1::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing content category. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ContentCategory] # # @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 update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/contentCategories' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_1::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_1::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one country by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] dart_id # Country DART ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Country] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Country] # # @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_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/countries/{dartId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Country::Representation command.response_class = Google::Apis::DfareportingV2_1::Country command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of countries. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCountriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCountriesResponse] # # @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_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/countries' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCountriesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCountriesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new creative asset. # @param [String] profile_id # User profile ID associated with this request. # @param [String] advertiser_id # Advertiser ID of this creative. This is a required field. # @param [Google::Apis::DfareportingV2_1::CreativeAssetMetadata] creative_asset_metadata_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::DfareportingV2_1::CreativeAssetMetadata] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeAssetMetadata] # # @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 insert_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' if upload_source.nil? command = make_simple_command(:post, path, options) else command = make_upload_command(:post, path, options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::DfareportingV2_1::CreativeAssetMetadata::Representation command.request_object = creative_asset_metadata_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeAssetMetadata::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeAssetMetadata command.params['profileId'] = profile_id unless profile_id.nil? 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing creative field value. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [String] id # Creative Field Value ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one creative field value by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [String] id # Creative Field Value ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeFieldValue] # # @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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new creative field value. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV2_1::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeFieldValue] # # @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 insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of creative field values, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [Array, String] ids # Select only creative field values with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative field values by their values. Wildcards (e.g. *) # are not allowed. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCreativeFieldValuesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCreativeFieldValuesResponse] # # @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_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCreativeFieldValuesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCreativeFieldValuesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative field value. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV2_1::CreativeFieldValue] creative_field_value_object # @param [String] id # Creative Field Value ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeFieldValue] # # @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_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative field value. # @param [String] profile_id # User profile ID associated with this request. # @param [String] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV2_1::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeFieldValue] # # @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 update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing creative field. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Creative Field ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one creative field by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Creative Field ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeField] # # @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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new creative field. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeField] # # @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 insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of creative fields, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_ids # Select only creative fields that belong to these advertisers. # @param [Array, String] ids # Select only creative fields with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative fields by name or ID. Wildcards (*) are allowed. # For example, "creativefield*2015" will return creative fields with names like " # creativefield June 2015", "creativefield April 2015", or simply "creativefield # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativefield" # will match creative fields with the name "my creativefield", "creativefield # 2015", or simply "creativefield". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCreativeFieldsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCreativeFieldsResponse] # # @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_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCreativeFieldsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCreativeFieldsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative field. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeField] creative_field_object # @param [String] id # Creative Field ID # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeField] # # @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_creative_field(profile_id, creative_field_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative field. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeField] # # @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 update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeFields' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one creative group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Creative group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeGroup] # # @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_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new creative group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeGroup] # # @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 insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeGroups' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of creative groups, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_ids # Select only creative groups that belong to these advertisers. # @param [Fixnum] group_number # Select only creative groups that belong to this subgroup. # @param [Array, String] ids # Select only creative groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative groups by name or ID. Wildcards (*) are allowed. # For example, "creativegroup*2015" will return creative groups with names like " # creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativegroup" # will match creative groups with the name "my creativegroup", "creativegroup # 2015", or simply "creativegroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCreativeGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListCreativeGroupsResponse] # # @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_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCreativeGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCreativeGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['groupNumber'] = group_number unless group_number.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative group. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeGroup] creative_group_object # @param [String] id # Creative group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeGroup] # # @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_creative_group(profile_id, creative_group_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeGroups' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CreativeGroup] # # @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 update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creativeGroups' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_1::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one creative by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Creative ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creatives/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.response_class = Google::Apis::DfareportingV2_1::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new creative. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creatives' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.response_class = Google::Apis::DfareportingV2_1::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of creatives, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active creatives. Leave blank to select active and inactive # creatives. # @param [String] advertiser_id # Select only creatives with this advertiser ID. # @param [Boolean] archived # Select only archived creatives. Leave blank to select archived and unarchived # creatives. # @param [String] campaign_id # Select only creatives with this campaign ID. # @param [Array, String] companion_creative_ids # Select only in-stream video creatives with these companion IDs. # @param [Array, String] creative_field_ids # Select only creatives with these creative field IDs. # @param [Array, String] ids # Select only creatives with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, String] rendering_ids # Select only creatives with these rendering IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "creative*2015" will return objects with names like "creative June # 2015", "creative April 2015", or simply "creative 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "creative" will match objects with name "my # creative", "creative 2015", or simply "creative". # @param [Array, String] size_ids # Select only creatives with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] studio_creative_id # Select only creatives corresponding to this Studio creative ID. # @param [Array, String] types # Select only creatives with these creative types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListCreativesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creatives' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListCreativesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListCreativesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['companionCreativeIds'] = companion_creative_ids unless companion_creative_ids.nil? command.query['creativeFieldIds'] = creative_field_ids unless creative_field_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['renderingIds'] = rendering_ids unless rendering_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['studioCreativeId'] = studio_creative_id unless studio_creative_id.nil? command.query['types'] = types unless types.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Creative] creative_object # @param [String] id # Creative ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_creative(profile_id, creative_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creatives' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.response_class = Google::Apis::DfareportingV2_1::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing creative. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/creatives' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_1::Creative::Representation command.response_class = Google::Apis::DfareportingV2_1::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves list of report dimension values for a list of filters. # @param [String] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_1::DimensionValueRequest] dimension_value_request_object # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::DimensionValueList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::DimensionValueList] # # @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 query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/dimensionvalues/query' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::DimensionValueRequest::Representation command.request_object = dimension_value_request_object command.response_representation = Google::Apis::DfareportingV2_1::DimensionValueList::Representation command.response_class = Google::Apis::DfareportingV2_1::DimensionValueList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one directory site contact by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Directory site contact ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::DirectorySiteContact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::DirectorySiteContact] # # @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_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/directorySiteContacts/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::DirectorySiteContact::Representation command.response_class = Google::Apis::DfareportingV2_1::DirectorySiteContact command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of directory site contacts, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] directory_site_ids # Select only directory site contacts with these directory site IDs. This is a # required field. # @param [Array, String] ids # Select only directory site contacts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "directory site contact*2015" will return objects with names like # "directory site contact June 2015", "directory site contact April 2015", or # simply "directory site contact 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "directory site contact" will match objects with name "my # directory site contact", "directory site contact 2015", or simply "directory # site contact". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListDirectorySiteContactsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListDirectorySiteContactsResponse] # # @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_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/directorySiteContacts' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListDirectorySiteContactsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListDirectorySiteContactsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one directory site by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Directory site ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::DirectorySite] # # @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_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/directorySites/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV2_1::DirectorySite command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new directory site. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::DirectorySite] directory_site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::DirectorySite] # # @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 insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/directorySites' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::DirectorySite::Representation command.request_object = directory_site_object command.response_representation = Google::Apis::DfareportingV2_1::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV2_1::DirectorySite command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of directory sites, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only directory sites that accept publisher paid placements. This field # can be left blank. # @param [Boolean] active # Select only active directory sites. Leave blank to retrieve both active and # inactive directory sites. # @param [String] country_id # Select only directory sites with this country ID. # @param [String] dfp_network_code # Select only directory sites with this DFP network code. # @param [Array, String] ids # Select only directory sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] parent_id # Select only directory sites with this parent ID. # @param [String] search_string # Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. # For example, "directory site*2015" will return objects with names like " # directory site June 2015", "directory site April 2015", or simply "directory # site 2015". Most of the searches also add wildcards implicitly at the start # and the end of the search string. For example, a search string of "directory # site" will match objects with name "my directory site", "directory site 2015" # or simply, "directory site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListDirectorySitesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListDirectorySitesResponse] # # @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_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/directorySites' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListDirectorySitesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListDirectorySitesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['active'] = active unless active.nil? command.query['countryId'] = country_id unless country_id.nil? command.query['dfp_network_code'] = dfp_network_code unless dfp_network_code.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parentId'] = parent_id unless parent_id.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing event tag. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Event tag ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one event tag by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Event tag ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::EventTag] # # @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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_1::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new event tag. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::EventTag] # # @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 insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_1::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of event tags, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] ad_id # Select only event tags that belong to this ad. # @param [String] advertiser_id # Select only event tags that belong to this advertiser. # @param [String] campaign_id # Select only event tags that belong to this campaign. # @param [Boolean] definitions_only # Examine only the specified ad or campaign or advertiser's event tags for # matching selector criteria. When set to false, the parent advertiser and # parent campaign is examined as well. In addition, when set to false, the # status field is examined as well along with the enabledByDefault field. # @param [Boolean] enabled # Select only enabled event tags. When definitionsOnly is set to true, only the # specified advertiser or campaign's event tags' enabledByDefault field is # examined. When definitionsOnly is set to false, the specified ad or specified # campaign's parent advertiser's or parent campaign's event tags' # enabledByDefault and status fields are examined as well. # @param [Array, String] event_tag_types # Select only event tags with the specified event tag types. Event tag types can # be used to specify whether to use a third-party pixel, a third-party # JavaScript URL, or a third-party click-through URL for either impression or # click tracking. # @param [Array, String] ids # Select only event tags with these IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "eventtag*2015" will return objects with names like "eventtag June # 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "eventtag" will match objects with name "my # eventtag", "eventtag 2015", or simply "eventtag". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListEventTagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListEventTagsResponse] # # @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_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListEventTagsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListEventTagsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['adId'] = ad_id unless ad_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['definitionsOnly'] = definitions_only unless definitions_only.nil? command.query['enabled'] = enabled unless enabled.nil? command.query['eventTagTypes'] = event_tag_types unless event_tag_types.nil? command.query['ids'] = ids unless ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing event tag. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::EventTag] event_tag_object # @param [String] id # Event tag ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::EventTag] # # @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_event_tag(profile_id, event_tag_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_1::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing event tag. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::EventTag] # # @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 update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/eventTags' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_1::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_1::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a report file by its report ID and file ID. # @param [String] report_id # The ID of the report. # @param [String] file_id # The ID of the report file. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::DfareportingV2_1::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::File] # # @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_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) path = 'reports/{reportId}/files/{fileId}' if download_dest.nil? command = make_simple_command(:get, path, options) else command = make_download_command(:get, path, options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV2_1::File::Representation command.response_class = Google::Apis::DfareportingV2_1::File command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists files for a user profile. # @param [String] profile_id # The DFA profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned, default is 'MINE'. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is 'DESCENDING'. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FileList] # # @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_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/files' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FileList::Representation command.response_class = Google::Apis::DfareportingV2_1::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing floodlight activity. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Floodlight activity ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Generates a tag for a floodlight activity. # @param [String] profile_id # User profile ID associated with this request. # @param [String] floodlight_activity_id # Floodlight activity ID for which we want to generate a tag. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivitiesGenerateTagResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivitiesGenerateTagResponse] # # @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 generate_floodlight_activity_tag(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities/generatetag' command = make_simple_command(:post, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivitiesGenerateTagResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivitiesGenerateTagResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one floodlight activity by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Floodlight activity ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivity] # # @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_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new floodlight activity. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivity] # # @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 insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of floodlight activities, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] advertiser_id # Select only floodlight activities for the specified advertiser ID. Must # specify either ids, advertiserId, or floodlightConfigurationId for a non-empty # result. # @param [Array, String] floodlight_activity_group_ids # Select only floodlight activities with the specified floodlight activity group # IDs. # @param [String] floodlight_activity_group_name # Select only floodlight activities with the specified floodlight activity group # name. # @param [String] floodlight_activity_group_tag_string # Select only floodlight activities with the specified floodlight activity group # tag string. # @param [String] floodlight_activity_group_type # Select only floodlight activities with the specified floodlight activity group # type. # @param [String] floodlight_configuration_id # Select only floodlight activities for the specified floodlight configuration # ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a # non-empty result. # @param [Array, String] ids # Select only floodlight activities with the specified IDs. Must specify either # ids, advertiserId, or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivity*2015" will return objects with names like " # floodlightactivity June 2015", "floodlightactivity April 2015", or simply " # floodlightactivity 2015". Most of the searches also add wildcards implicitly # at the start and the end of the search string. For example, a search string of # "floodlightactivity" will match objects with name "my floodlightactivity # activity", "floodlightactivity 2015", or simply "floodlightactivity". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] tag_string # Select only floodlight activities with the specified tag string. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListFloodlightActivitiesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListFloodlightActivitiesResponse] # # @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_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListFloodlightActivitiesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListFloodlightActivitiesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityGroupIds'] = floodlight_activity_group_ids unless floodlight_activity_group_ids.nil? command.query['floodlightActivityGroupName'] = floodlight_activity_group_name unless floodlight_activity_group_name.nil? command.query['floodlightActivityGroupTagString'] = floodlight_activity_group_tag_string unless floodlight_activity_group_tag_string.nil? command.query['floodlightActivityGroupType'] = floodlight_activity_group_type unless floodlight_activity_group_type.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['tagString'] = tag_string unless tag_string.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight activity. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivity] floodlight_activity_object # @param [String] id # Floodlight activity ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivity] # # @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_activity(profile_id, floodlight_activity_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight activity. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivity] # # @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 update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivities' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing floodlight activity group. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Floodlight activity Group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one floodlight activity group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Floodlight activity Group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] # # @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_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new floodlight activity group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] # # @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 insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of floodlight activity groups, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] advertiser_id # Select only floodlight activity groups with the specified advertiser ID. Must # specify either advertiserId or floodlightConfigurationId for a non-empty # result. # @param [String] floodlight_configuration_id # Select only floodlight activity groups with the specified floodlight # configuration ID. Must specify either advertiserId, or # floodlightConfigurationId for a non-empty result. # @param [Array, String] ids # Select only floodlight activity groups with the specified IDs. Must specify # either advertiserId or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivitygroup*2015" will return objects with names like " # floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or # simply "floodlightactivitygroup 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "floodlightactivitygroup" will match objects with name "my # floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply " # floodlightactivitygroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] type # Select only floodlight activity groups with the specified floodlight activity # group type. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListFloodlightActivityGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListFloodlightActivityGroupsResponse] # # @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_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListFloodlightActivityGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListFloodlightActivityGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight activity group. This method supports patch # semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] floodlight_activity_group_object # @param [String] id # Floodlight activity Group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] # # @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_activity_group(profile_id, floodlight_activity_group_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight activity group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightActivityGroup] # # @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 update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightActivityGroups' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one floodlight configuration by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Floodlight configuration ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightConfiguration] # # @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_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightConfigurations/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of floodlight configurations, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Set of IDs of floodlight configurations to retrieve. Required field; otherwise # an empty list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListFloodlightConfigurationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListFloodlightConfigurationsResponse] # # @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_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightConfigurations' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListFloodlightConfigurationsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListFloodlightConfigurationsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight configuration. This method supports patch # semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightConfiguration] floodlight_configuration_object # @param [String] id # Floodlight configuration ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightConfiguration] # # @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_configuration(profile_id, floodlight_configuration_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightConfigurations' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing floodlight configuration. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::FloodlightConfiguration] floodlight_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FloodlightConfiguration] # # @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 update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/floodlightConfigurations' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV2_1::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_1::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one inventory item by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for order documents. # @param [String] id # Inventory item ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::InventoryItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::InventoryItem] # # @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_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::InventoryItem::Representation command.response_class = Google::Apis::DfareportingV2_1::InventoryItem command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of inventory items, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for order documents. # @param [Array, String] ids # Select only inventory items with these IDs. # @param [Boolean] in_plan # Select only inventory items that are in plan. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, String] order_id # Select only inventory items that belong to specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, String] site_id # Select only inventory items that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListInventoryItemsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListInventoryItemsResponse] # # @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_items(profile_id, project_id, ids: nil, in_plan: nil, max_results: nil, order_id: nil, page_token: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/inventoryItems' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListInventoryItemsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListInventoryItemsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['inPlan'] = in_plan unless in_plan.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing campaign landing page. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @param [String] id # Landing page ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one campaign landing page by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @param [String] id # Landing page ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::LandingPage] # # @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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_1::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new landing page for the specified campaign. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @param [Google::Apis::DfareportingV2_1::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::LandingPage] # # @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 insert_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_1::LandingPage command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of landing pages for the specified campaign. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListLandingPagesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListLandingPagesResponse] # # @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_landing_pages(profile_id, campaign_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListLandingPagesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListLandingPagesResponse command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing campaign landing page. This method supports patch # semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @param [Google::Apis::DfareportingV2_1::LandingPage] landing_page_object # @param [String] id # Landing page ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::LandingPage] # # @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_landing_page(profile_id, campaign_id, landing_page_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_1::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing campaign landing page. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Landing page campaign ID. # @param [Google::Apis::DfareportingV2_1::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::LandingPage] # # @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 update_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_1::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_1::LandingPage command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of metros. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListMetrosResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListMetrosResponse] # # @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_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/metros' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListMetrosResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListMetrosResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one mobile carrier by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Mobile carrier ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::MobileCarrier] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::MobileCarrier] # # @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_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/mobileCarriers/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::MobileCarrier::Representation command.response_class = Google::Apis::DfareportingV2_1::MobileCarrier command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of mobile carriers. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListMobileCarriersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListMobileCarriersResponse] # # @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_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/mobileCarriers' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListMobileCarriersResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListMobileCarriersResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one operating system version by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Operating system version ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::OperatingSystemVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::OperatingSystemVersion] # # @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_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/operatingSystemVersions/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::OperatingSystemVersion::Representation command.response_class = Google::Apis::DfareportingV2_1::OperatingSystemVersion command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of operating system versions. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListOperatingSystemVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListOperatingSystemVersionsResponse] # # @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_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/operatingSystemVersions' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListOperatingSystemVersionsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListOperatingSystemVersionsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one operating system by DART ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] dart_id # Operating system DART ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::OperatingSystem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::OperatingSystem] # # @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_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/operatingSystems/{dartId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::OperatingSystem::Representation command.response_class = Google::Apis::DfareportingV2_1::OperatingSystem command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of operating systems. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListOperatingSystemsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListOperatingSystemsResponse] # # @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_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/operatingSystems' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListOperatingSystemsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListOperatingSystemsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one order document by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for order documents. # @param [String] id # Order document ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::OrderDocument] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::OrderDocument] # # @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_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::OrderDocument::Representation command.response_class = Google::Apis::DfareportingV2_1::OrderDocument command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of order documents, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for order documents. # @param [Boolean] approved # Select only order documents that have been approved by at least one user. # @param [Array, String] ids # Select only order documents with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, String] order_id # Select only order documents for specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for order documents by name or ID. Wildcards (*) are allowed. # For example, "orderdocument*2015" will return order documents with names like " # orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "orderdocument" will # match order documents with name "my orderdocument", "orderdocument 2015", or # simply "orderdocument". # @param [Array, String] site_id # Select only order documents that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListOrderDocumentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListOrderDocumentsResponse] # # @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_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/orderDocuments' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListOrderDocumentsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListOrderDocumentsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['approved'] = approved unless approved.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one order by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for orders. # @param [String] id # Order ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Order] # # @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_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/orders/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Order::Representation command.response_class = Google::Apis::DfareportingV2_1::Order command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of orders, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [String] project_id # Project ID for orders. # @param [Array, String] ids # Select only orders with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for orders by name or ID. Wildcards (*) are allowed. For # example, "order*2015" will return orders with names like "order June 2015", " # order April 2015", or simply "order 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "order" will match orders with name "my order", " # order 2015", or simply "order". # @param [Array, String] site_id # Select only orders that are associated with these site IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListOrdersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListOrdersResponse] # # @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_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{projectId}/orders' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListOrdersResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListOrdersResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one placement group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Placement group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementGroup] # # @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_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new placement group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementGroup] # # @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 insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementGroups' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of placement groups, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_ids # Select only placement groups that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, String] campaign_ids # Select only placement groups that belong to these campaigns. # @param [Array, String] content_category_ids # Select only placement groups that are associated with these content categories. # @param [Array, String] directory_site_ids # Select only placement groups that are associated with these directory sites. # @param [Array, String] ids # Select only placement groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] placement_group_type # Select only placement groups belonging with this group type. A package is a # simple group of placements that acts as a single pricing point for a group of # tags. A roadblock is a group of placements that not only acts as a single # pricing point but also assumes that all the tags in it will be served at the # same time. A roadblock requires one of its assigned placements to be marked as # primary for reporting. # @param [Array, String] placement_strategy_ids # Select only placement groups that are associated with these placement # strategies. # @param [Array, String] pricing_types # Select only placement groups with these pricing types. # @param [String] search_string # Allows searching for placement groups by name or ID. Wildcards (*) are allowed. # For example, "placement*2015" will return placement groups with names like " # placement group June 2015", "placement group May 2015", or simply "placements # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "placementgroup" # will match placement groups with name "my placementgroup", "placementgroup # 2015", or simply "placementgroup". # @param [Array, String] site_ids # Select only placement groups that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListPlacementGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListPlacementGroupsResponse] # # @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_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListPlacementGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListPlacementGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementGroupType'] = placement_group_type unless placement_group_type.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement group. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementGroup] placement_group_object # @param [String] id # Placement group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementGroup] # # @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_placement_group(profile_id, placement_group_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementGroups' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement group. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementGroup] # # @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 update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementGroups' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing placement strategy. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Placement strategy ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one placement strategy by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Placement strategy ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementStrategy] # # @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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new placement strategy. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementStrategy] # # @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 insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of placement strategies, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Select only placement strategies with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "placementstrategy*2015" will return objects with names like " # placementstrategy June 2015", "placementstrategy April 2015", or simply " # placementstrategy 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # placementstrategy" will match objects with name "my placementstrategy", " # placementstrategy 2015", or simply "placementstrategy". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListPlacementStrategiesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListPlacementStrategiesResponse] # # @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_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListPlacementStrategiesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListPlacementStrategiesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement strategy. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementStrategy] placement_strategy_object # @param [String] id # Placement strategy ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementStrategy] # # @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_placement_strategy(profile_id, placement_strategy_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement strategy. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlacementStrategy] # # @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 update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placementStrategies' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_1::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_1::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Generates tags for a placement. # @param [String] profile_id # User profile ID associated with this request. # @param [String] campaign_id # Generate placements belonging to this campaign. This is a required field. # @param [Array, String] placement_ids # Generate tags for these placements. # @param [Array, String] tag_formats # Tag formats to generate for these placements. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::GeneratePlacementsTagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::GeneratePlacementsTagsResponse] # # @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 generate_placement_tags(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements/generatetags' command = make_simple_command(:post, path, options) command.response_representation = Google::Apis::DfareportingV2_1::GeneratePlacementsTagsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::GeneratePlacementsTagsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['tagFormats'] = tag_formats unless tag_formats.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one placement by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Placement ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Placement] # # @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_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.response_class = Google::Apis::DfareportingV2_1::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new placement. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Placement] # # @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 insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.response_class = Google::Apis::DfareportingV2_1::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of placements, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_ids # Select only placements that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, String] campaign_ids # Select only placements that belong to these campaigns. # @param [Array, String] compatibilities # Select only placements that are associated with these compatibilities. WEB and # WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for # regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for # rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream # video ads developed with the VAST standard. # @param [Array, String] content_category_ids # Select only placements that are associated with these content categories. # @param [Array, String] directory_site_ids # Select only placements that are associated with these directory sites. # @param [Array, String] group_ids # Select only placements that belong to these placement groups. # @param [Array, String] ids # Select only placements with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] payment_source # Select only placements with this payment source. # @param [Array, String] placement_strategy_ids # Select only placements that are associated with these placement strategies. # @param [Array, String] pricing_types # Select only placements with these pricing types. # @param [String] search_string # Allows searching for placements by name or ID. Wildcards (*) are allowed. For # example, "placement*2015" will return placements with names like "placement # June 2015", "placement May 2015", or simply "placements 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "placement" will match placements with # name "my placement", "placement 2015", or simply "placement". # @param [Array, String] site_ids # Select only placements that are associated with these sites. # @param [Array, String] size_ids # Select only placements that are associated with these sizes. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListPlacementsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListPlacementsResponse] # # @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_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_results: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListPlacementsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListPlacementsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibilities'] = compatibilities unless compatibilities.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['groupIds'] = group_ids unless group_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['paymentSource'] = payment_source unless payment_source.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Placement] placement_object # @param [String] id # Placement ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Placement] # # @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_placement(profile_id, placement_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.response_class = Google::Apis::DfareportingV2_1::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing placement. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Placement] # # @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 update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/placements' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_1::Placement::Representation command.response_class = Google::Apis::DfareportingV2_1::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one platform type by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Platform type ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PlatformType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PlatformType] # # @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_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/platformTypes/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::PlatformType::Representation command.response_class = Google::Apis::DfareportingV2_1::PlatformType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of platform types. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListPlatformTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListPlatformTypesResponse] # # @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_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/platformTypes' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListPlatformTypesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListPlatformTypesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one postal code by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] code # Postal code ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::PostalCode] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::PostalCode] # # @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_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/postalCodes/{code}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::PostalCode::Representation command.response_class = Google::Apis::DfareportingV2_1::PostalCode command.params['profileId'] = profile_id unless profile_id.nil? command.params['code'] = code unless code.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of postal codes. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListPostalCodesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListPostalCodesResponse] # # @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_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/postalCodes' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListPostalCodesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListPostalCodesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one project by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Project ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Project] # # @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_project(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Project::Representation command.response_class = Google::Apis::DfareportingV2_1::Project command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of projects, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] advertiser_ids # Select only projects with these advertiser IDs. # @param [Array, String] ids # Select only projects with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for projects by name or ID. Wildcards (*) are allowed. For # example, "project*2015" will return projects with names like "project June # 2015", "project April 2015", or simply "project 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "project" will match projects with name "my # project", "project 2015", or simply "project". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListProjectsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListProjectsResponse] # # @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_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/projects' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListProjectsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListProjectsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of regions. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListRegionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListRegionsResponse] # # @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_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/regions' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListRegionsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListRegionsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one remarketing list share by remarketing list ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] remarketing_list_id # Remarketing list ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingListShare] # # @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_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing remarketing list share. This method supports patch # semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::RemarketingListShare] remarketing_list_share_object # @param [String] remarketing_list_id # Remarketing list ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingListShare] # # @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_remarketing_list_share(profile_id, remarketing_list_share_object = nil, remarketing_list_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingListShares' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV2_1::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing remarketing list share. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::RemarketingListShare] remarketing_list_share_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingListShare] # # @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 update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingListShares' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV2_1::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one remarketing list by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Remarketing list ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingList] # # @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_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingLists/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new remarketing list. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::RemarketingList] remarketing_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingList] # # @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 insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingLists' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of remarketing lists, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active or only inactive remarketing lists. # @param [String] advertiser_id # Select only remarketing lists owned by this advertiser. # @param [String] floodlight_activity_id # Select only remarketing lists that have this floodlight activity ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListRemarketingListsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListRemarketingListsResponse] # # @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_remarketing_lists(profile_id, active: nil, advertiser_id: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingLists' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListRemarketingListsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListRemarketingListsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing remarketing list. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::RemarketingList] remarketing_list_object # @param [String] id # Remarketing list ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingList] # # @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_remarketing_list(profile_id, remarketing_list_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingLists' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing remarketing list. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::RemarketingList] remarketing_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::RemarketingList] # # @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 update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/remarketingLists' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_1::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_1::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a report by its ID. # @param [String] profile_id # The DFA user profile ID. # @param [String] report_id # The ID of the report. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a report by its ID. # @param [String] profile_id # The DFA user profile ID. # @param [String] report_id # The ID of the report. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Report] # # @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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Report::Representation command.response_class = Google::Apis::DfareportingV2_1::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a report. # @param [String] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_1::Report] report_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Report] # # @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 insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_1::Report::Representation command.response_class = Google::Apis::DfareportingV2_1::Report command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves list of reports. # @param [String] profile_id # The DFA user profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned, default is 'MINE'. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is 'DESCENDING'. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ReportList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ReportList] # # @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_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ReportList::Representation command.response_class = Google::Apis::DfareportingV2_1::ReportList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates a report. This method supports patch semantics. # @param [String] profile_id # The DFA user profile ID. # @param [String] report_id # The ID of the report. # @param [Google::Apis::DfareportingV2_1::Report] report_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Report] # # @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_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_1::Report::Representation command.response_class = Google::Apis::DfareportingV2_1::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Runs a report. # @param [String] profile_id # The DFA profile ID. # @param [String] report_id # The ID of the report. # @param [Boolean] synchronous # If set and true, tries to run the report synchronously. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::File] # # @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 run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}/run' command = make_simple_command(:post, path, options) command.response_representation = Google::Apis::DfareportingV2_1::File::Representation command.response_class = Google::Apis::DfareportingV2_1::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['synchronous'] = synchronous unless synchronous.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates a report. # @param [String] profile_id # The DFA user profile ID. # @param [String] report_id # The ID of the report. # @param [Google::Apis::DfareportingV2_1::Report] report_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Report] # # @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 update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_1::Report::Representation command.response_class = Google::Apis::DfareportingV2_1::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Returns the fields that are compatible to be selected in the respective # sections of a report criteria, given the fields already selected in the input # report and user permissions. # @param [String] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_1::Report] report_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::CompatibleFields] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::CompatibleFields] # # @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 query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/compatiblefields/query' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_1::CompatibleFields::Representation command.response_class = Google::Apis::DfareportingV2_1::CompatibleFields command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a report file. # @param [String] profile_id # The DFA profile ID. # @param [String] report_id # The ID of the report. # @param [String] file_id # The ID of the report file. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::DfareportingV2_1::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::File] # # @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_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}' if download_dest.nil? command = make_simple_command(:get, path, options) else command = make_download_command(:get, path, options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV2_1::File::Representation command.response_class = Google::Apis::DfareportingV2_1::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists files for a report. # @param [String] profile_id # The DFA profile ID. # @param [String] report_id # The ID of the parent report. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is 'DESCENDING'. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::FileList] # # @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_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/reports/{reportId}/files' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::FileList::Representation command.response_class = Google::Apis::DfareportingV2_1::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one site by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Site ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 get_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sites/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Site::Representation command.response_class = Google::Apis::DfareportingV2_1::Site command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new site. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sites' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_1::Site::Representation command.response_class = Google::Apis::DfareportingV2_1::Site command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of sites, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only sites that accept publisher paid placements. # @param [Boolean] ad_words_site # Select only AdWords sites. # @param [Boolean] approved # Select only approved sites. # @param [Array, String] campaign_ids # Select only sites with these campaign IDs. # @param [Array, String] directory_site_ids # Select only sites with these directory site IDs. # @param [Array, String] ids # Select only sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. # For example, "site*2015" will return objects with names like "site June 2015", # "site April 2015", or simply "site 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "site" will match objects with name "my site", " # site 2015", or simply "site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] subaccount_id # Select only sites with this subaccount ID. # @param [Boolean] unmapped_site # Select only sites that have not been mapped to a directory site. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListSitesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sites' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListSitesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListSitesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['adWordsSite'] = ad_words_site unless ad_words_site.nil? command.query['approved'] = approved unless approved.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['unmappedSite'] = unmapped_site unless unmapped_site.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing site. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Site] site_object # @param [String] id # Site ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 patch_site(profile_id, site_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sites' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_1::Site::Representation command.response_class = Google::Apis::DfareportingV2_1::Site command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing site. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::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 update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sites' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_1::Site::Representation command.response_class = Google::Apis::DfareportingV2_1::Site command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one size by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Size ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Size] # # @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_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sizes/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Size::Representation command.response_class = Google::Apis::DfareportingV2_1::Size command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new size. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Size] size_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Size] # # @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 insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sizes' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Size::Representation command.request_object = size_object command.response_representation = Google::Apis::DfareportingV2_1::Size::Representation command.response_class = Google::Apis::DfareportingV2_1::Size command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of sizes, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Fixnum] height # Select only sizes with this height. # @param [Boolean] iab_standard # Select only IAB standard sizes. # @param [Array, String] ids # Select only sizes with these IDs. # @param [Fixnum] width # Select only sizes with this width. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListSizesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListSizesResponse] # # @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_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/sizes' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListSizesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListSizesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['height'] = height unless height.nil? command.query['iabStandard'] = iab_standard unless iab_standard.nil? command.query['ids'] = ids unless ids.nil? command.query['width'] = width unless width.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one subaccount by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Subaccount ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Subaccount] # # @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_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/subaccounts/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_1::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new subaccount. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Subaccount] # # @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 insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/subaccounts' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_1::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a list of subaccounts, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Select only subaccounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "subaccount*2015" will return objects with names like "subaccount # June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "subaccount" will match objects with # name "my subaccount", "subaccount 2015", or simply "subaccount". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListSubaccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListSubaccountsResponse] # # @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_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/subaccounts' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListSubaccountsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListSubaccountsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing subaccount. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Subaccount] subaccount_object # @param [String] id # Subaccount ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Subaccount] # # @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_subaccount(profile_id, subaccount_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/subaccounts' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_1::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing subaccount. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::Subaccount] # # @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 update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/subaccounts' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_1::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_1::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one remarketing list by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # Remarketing list ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::TargetableRemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::TargetableRemarketingList] # # @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_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/targetableRemarketingLists/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::TargetableRemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_1::TargetableRemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of targetable remarketing lists, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active or only inactive targetable remarketing lists. # @param [String] advertiser_id # Select only targetable remarketing lists targetable by these advertisers. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListTargetableRemarketingListsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListTargetableRemarketingListsResponse] # # @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_targetable_remarketing_lists(profile_id, active: nil, advertiser_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/targetableRemarketingLists' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListTargetableRemarketingListsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListTargetableRemarketingListsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one user profile by ID. # @param [String] profile_id # The user profile ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserProfile] # # @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_profile(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::UserProfile::Representation command.response_class = Google::Apis::DfareportingV2_1::UserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves list of user profiles for a user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserProfileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserProfileList] # # @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_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::UserProfileList::Representation command.response_class = Google::Apis::DfareportingV2_1::UserProfileList command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one user role permission group by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # User role permission group ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRolePermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRolePermissionGroup] # # @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_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRolePermissionGroups/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::UserRolePermissionGroup::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRolePermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a list of all supported user role permission groups. # @param [String] profile_id # User profile ID associated with this request. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListUserRolePermissionGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListUserRolePermissionGroupsResponse] # # @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_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRolePermissionGroups' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListUserRolePermissionGroupsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListUserRolePermissionGroupsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one user role permission by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # User role permission ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRolePermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRolePermission] # # @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_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRolePermissions/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::UserRolePermission::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRolePermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a list of user role permissions, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Array, String] ids # Select only user role permissions with these IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListUserRolePermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListUserRolePermissionsResponse] # # @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_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRolePermissions' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListUserRolePermissionsResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListUserRolePermissionsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing user role. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # User role ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @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_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles/{id}' command = make_simple_command(:delete, path, options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets one user role by ID. # @param [String] profile_id # User profile ID associated with this request. # @param [String] id # User role ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRole] # # @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_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a new user role. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRole] # # @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 insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of user roles, possibly filtered. # @param [String] profile_id # User profile ID associated with this request. # @param [Boolean] account_user_role_only # Select only account level user roles not associated with any specific # subaccount. # @param [Array, String] ids # Select only user roles with the specified IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "userrole*2015" will return objects with names like "userrole June # 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "userrole" will match objects with name "my # userrole", "userrole 2015", or simply "userrole". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results, default is ASCENDING. # @param [String] subaccount_id # Select only user roles that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::ListUserRolesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::ListUserRolesResponse] # # @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_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::DfareportingV2_1::ListUserRolesResponse::Representation command.response_class = Google::Apis::DfareportingV2_1::ListUserRolesResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['accountUserRoleOnly'] = account_user_role_only unless account_user_role_only.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing user role. This method supports patch semantics. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::UserRole] user_role_object # @param [String] id # User role ID. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRole] # # @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_role(profile_id, user_role_object = nil, id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing user role. # @param [String] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_1::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_1::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_1::UserRole] # # @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 update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'userprofiles/{profileId}/userRoles' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_1::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_1::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end protected def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end end end end end