Class: Google::Apis::DfareportingV3_4::DfareportingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/dfareporting_v3_4/service.rb

Overview

Campaign Manager 360 API

Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.

Examples:

require 'google/apis/dfareporting_v3_4'

Dfareporting = Google::Apis::DfareportingV3_4 # Alias the module
service = Dfareporting::DfareportingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDfareportingService

Returns a new instance of DfareportingService.



46
47
48
49
50
51
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 46

def initialize
  super('https://dfareporting.googleapis.com/', 'dfareporting/v3.4/',
        client_name: 'google-apis-dfareporting_v3_4',
        client_version: Google::Apis::DfareportingV3_4::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ConversionsBatchInsertResponse

Inserts conversions.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • conversions_batch_insert_request_object (Google::Apis::DfareportingV3_4::ConversionsBatchInsertRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2220

def batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchinsert', options)
  command.request_representation = Google::Apis::DfareportingV3_4::ConversionsBatchInsertRequest::Representation
  command.request_object = conversions_batch_insert_request_object
  command.response_representation = Google::Apis::DfareportingV3_4::ConversionsBatchInsertResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ConversionsBatchInsertResponse
  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?
  execute_or_queue_command(command, &block)
end

#batchinsert_custom_event(profile_id, custom_events_batch_insert_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse

Inserts custom events.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • custom_events_batch_insert_request_object (Google::Apis::DfareportingV3_4::CustomEventsBatchInsertRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3269

def batchinsert_custom_event(profile_id, custom_events_batch_insert_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/customEvents/batchinsert', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertRequest::Representation
  command.request_object = custom_events_batch_insert_request_object
  command.response_representation = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse
  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?
  execute_or_queue_command(command, &block)
end

#batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse

Updates existing conversions.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • conversions_batch_update_request_object (Google::Apis::DfareportingV3_4::ConversionsBatchUpdateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2253

def batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchupdate', options)
  command.request_representation = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateRequest::Representation
  command.request_object = conversions_batch_update_request_object
  command.response_representation = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse
  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?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing advertiser group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Advertiser group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



838
839
840
841
842
843
844
845
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 838

def delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/advertiserGroups/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_content_category(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing content category.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Content category ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2000
2001
2002
2003
2004
2005
2006
2007
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2000

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/contentCategories/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_creative_field(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing creative field.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Creative Field ID

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2630
2631
2632
2633
2634
2635
2636
2637
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2630

def delete_creative_field(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing creative field value.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    Creative field ID for this creative field value.

  • id (Fixnum)

    Creative Field Value ID

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2398
2399
2400
2401
2402
2403
2404
2405
2406
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2398

def delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing dynamic targeting key.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • object_id_ (Fixnum)

    ID of the object of this dynamic targeting key. This is a required field.

  • name (String)

    Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.

  • object_type (String)

    Type of the object of this dynamic targeting key. This is a required field.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3488

def delete_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/dynamicTargetingKeys/{objectId}', options)
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['objectId'] = object_id_ unless object_id_.nil?
  command.query['name'] = name unless name.nil?
  command.query['objectType'] = object_type unless object_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_event_tag(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing event tag.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Event tag ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3599
3600
3601
3602
3603
3604
3605
3606
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3599

def delete_event_tag(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/eventTags/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing floodlight activity.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Floodlight activity ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3929
3930
3931
3932
3933
3934
3935
3936
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3929

def delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/floodlightActivities/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing placement strategy.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Placement strategy ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5424
5425
5426
5427
5428
5429
5430
5431
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5424

def delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/placementStrategies/{id}', 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?
  execute_or_queue_command(command, &block)
end

#delete_report(profile_id, report_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a report by its ID.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6474
6475
6476
6477
6478
6479
6480
6481
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6474

def delete_report(profile_id, report_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/reports/{reportId}', 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?
  execute_or_queue_command(command, &block)
end

#delete_user_role(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing user role.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    User role ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7833
7834
7835
7836
7837
7838
7839
7840
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7833

def delete_user_role(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'userprofiles/{profileId}/userRoles/{id}', 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?
  execute_or_queue_command(command, &block)
end

#generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivitiesGenerateTagResponse

Generates a tag for a floodlight activity.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_activity_id (Fixnum) (defaults to: nil)

    Floodlight activity ID for which we want to generate a tag.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3960

def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivitiesGenerateTagResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementsGenerateTagsResponse

Generates tags for a placement.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • campaign_id (Fixnum) (defaults to: nil)

    Generate placements belonging to this campaign. This is a required field.

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

    Generate tags for these placements.

  • tag_formats (Array<String>, String) (defaults to: nil)

    Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5650

def generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementsGenerateTagsResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PlacementsGenerateTagsResponse
  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?
  execute_or_queue_command(command, &block)
end

#get_account(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Account

Gets one account by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Account ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



433
434
435
436
437
438
439
440
441
442
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 433

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountActiveAdSummary

Gets the account's active ad summary by account ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • summary_account_id (Fixnum)

    Account ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



75
76
77
78
79
80
81
82
83
84
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 75

def (profile_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountActiveAdSummary::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AccountActiveAdSummary
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['summaryAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_permission(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountPermission

Gets one account permission by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Account permission ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



171
172
173
174
175
176
177
178
179
180
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 171

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountPermission::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_account_permission_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountPermissionGroup

Gets one account permission group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Account permission group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



108
109
110
111
112
113
114
115
116
117
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 108

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountPermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_account_user_profile(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountUserProfile

Gets one account user profile by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    User profile ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



234
235
236
237
238
239
240
241
242
243
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 234

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_ad(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Ad

Gets one ad by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Ad ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



592
593
594
595
596
597
598
599
600
601
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 592

def get_ad(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_advertiser(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Advertiser

Gets one advertiser by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Advertiser ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1262

def get_advertiser(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserGroup

Gets one advertiser group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Advertiser group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



869
870
871
872
873
874
875
876
877
878
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 869

def get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_advertiser_landing_page(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::LandingPage

Gets one landing page by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Landing page ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1059

def get_advertiser_landing_page(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_4::LandingPage
  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?
  execute_or_queue_command(command, &block)
end

#get_campaign(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Campaign

Gets one campaign by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Campaign ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1581

def get_campaign(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_change_log(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ChangeLog

Gets one change log by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Change log ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1791

def get_change_log(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ChangeLog::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_connection_type(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ConnectionType

Gets one connection type by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Connection type ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1937

def get_connection_type(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ConnectionType::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_content_category(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ContentCategory

Gets one content category by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Content category ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2031

def (profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_country(profile_id, dart_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Country

Gets one country by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • dart_id (Fixnum)

    Country DART ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2287

def get_country(profile_id, dart_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Country::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_creative(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Creative

Gets one creative by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Creative ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3050

def get_creative(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_creative_field(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeField

Gets one creative field by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Creative Field ID

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2661

def get_creative_field(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldValue

Gets one creative field value by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    Creative field ID for this creative field value.

  • id (Fixnum)

    Creative Field Value ID

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2432

def get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_creative_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeGroup

Gets one creative group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Creative group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2854

def get_creative_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_directory_site(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DirectorySite

Gets one directory site by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Directory site ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3342

def get_directory_site(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_event_tag(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::EventTag

Gets one event tag by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Event tag ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3630

def get_event_tag(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_file(report_id, file_id, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::File

Retrieves a report file by its report ID and file ID. This method supports media download.

Parameters:

  • report_id (Fixnum)

    The ID of the report.

  • file_id (Fixnum)

    The ID of the report file.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • download_dest (IO, String) (defaults to: nil)

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3846

def get_file(report_id, file_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options)
  else
    command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DfareportingV3_4::File::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivity

Gets one floodlight activity by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Floodlight activity ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3993

def get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivityGroup

Gets one floodlight activity group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Floodlight activity Group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4213

def get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightConfiguration

Gets one floodlight configuration by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Floodlight configuration ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4420

def get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::InventoryItem

Gets one inventory item by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for order documents.

  • id (Fixnum)

    Inventory item ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4559

def get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::InventoryItem::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_mobile_app(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::MobileApp

Gets one mobile app by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (String)

    Mobile app ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4714

def get_mobile_app(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/mobileApps/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::MobileApp::Representation
  command.response_class = Google::Apis::DfareportingV3_4::MobileApp
  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?
  execute_or_queue_command(command, &block)
end

#get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::MobileCarrier

Gets one mobile carrier by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Mobile carrier ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4797

def get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::MobileCarrier::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OperatingSystem

Gets one operating system by DART ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • dart_id (Fixnum)

    Operating system DART ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4923

def get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OperatingSystem::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OperatingSystemVersion

Gets one operating system version by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Operating system version ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4860

def get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OperatingSystemVersion::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_order(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Order

Gets one order by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for orders.

  • id (Fixnum)

    Order ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5091

def get_order(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Order::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OrderDocument

Gets one order document by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for order documents.

  • id (Fixnum)

    Order document ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4988

def get_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OrderDocument::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_placement(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Placement

Gets one placement by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Placement ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5685

def get_placement(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_placement_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementGroup

Gets one placement group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Placement group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5184

def get_placement_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementStrategy

Gets one placement strategy by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Placement strategy ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5455

def get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_platform_type(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlatformType

Gets one platform type by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Platform type ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5930

def get_platform_type(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlatformType::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_postal_code(profile_id, code, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PostalCode

Gets one postal code by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • code (String)

    Postal code ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5993

def get_postal_code(profile_id, code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PostalCode::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_project(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Project

Gets one project by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Project ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6056

def get_project(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Project::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingList

Gets one remarketing list by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Remarketing list ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6278

def get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingListShare

Gets one remarketing list share by remarketing list ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • remarketing_list_id (Fixnum)

    Remarketing list ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6175

def get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_report(profile_id, report_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Report

Retrieves a report by its ID.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6505

def get_report(profile_id, report_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::File

Retrieves a report file by its report ID and file ID. This method supports media download.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • file_id (Fixnum)

    The ID of the report file.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • download_dest (IO, String) (defaults to: nil)

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6764

def get_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options)
  else
    command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DfareportingV3_4::File::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_site(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Site

Gets one site by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Site ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6848

def get_site(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_size(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Size

Gets one size by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Size ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7065

def get_size(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Size::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_subaccount(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Subaccount

Gets one subaccount by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Subaccount ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7176

def get_subaccount(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetableRemarketingList

Gets one remarketing list by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Remarketing list ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7364

def get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::TargetableRemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_targeting_template(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetingTemplate

Gets one targeting template by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Targeting template ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7455

def get_targeting_template(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetingTemplate
  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?
  execute_or_queue_command(command, &block)
end

#get_user_profile(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserProfile

Gets one user profile by ID.

Parameters:

  • profile_id (Fixnum)

    The user profile ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7645
7646
7647
7648
7649
7650
7651
7652
7653
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7645

def (profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_user_role(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRole

Gets one user role by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    User role ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7864

def get_user_role(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRolePermission

Gets one user role permission by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    User role permission ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7767

def get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRolePermission::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRolePermissionGroup

Gets one user role permission group by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    User role permission group ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7704

def get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRolePermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#get_video_format(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::VideoFormat

Gets one video format by ID.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Video format ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 8059

def get_video_format(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_4::VideoFormat::Representation
  command.response_class = Google::Apis::DfareportingV3_4::VideoFormat
  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?
  execute_or_queue_command(command, &block)
end

#insert_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountUserProfile

Inserts a new account user profile.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • account_user_profile_object (Google::Apis::DfareportingV3_4::AccountUserProfile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



266
267
268
269
270
271
272
273
274
275
276
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 266

def (profile_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Ad

Inserts a new ad.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • ad_object (Google::Apis::DfareportingV3_4::Ad) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



624
625
626
627
628
629
630
631
632
633
634
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 624

def insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

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

Inserts a new advertiser.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1294

def insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserGroup

Inserts a new advertiser group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_group_object (Google::Apis::DfareportingV3_4::AdvertiserGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



901
902
903
904
905
906
907
908
909
910
911
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 901

def insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::LandingPage

Inserts a new landing page.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • landing_page_object (Google::Apis::DfareportingV3_4::LandingPage) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1091

def insert_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_4::LandingPage
  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?
  execute_or_queue_command(command, &block)
end

#insert_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Campaign

Inserts a new campaign.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1613

def insert_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CampaignCreativeAssociation

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.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • campaign_id (Fixnum)

    Campaign ID in this association.

  • campaign_creative_association_object (Google::Apis::DfareportingV3_4::CampaignCreativeAssociation) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1503

def insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CampaignCreativeAssociation::Representation
  command.request_object = campaign_creative_association_object
  command.response_representation = Google::Apis::DfareportingV3_4::CampaignCreativeAssociation::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ContentCategory

Inserts a new content category.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • content_category_object (Google::Apis::DfareportingV3_4::ContentCategory) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2063

def (profile_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Creative

Inserts a new creative.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3082

def insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeAssetMetadata

Inserts a new creative asset.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum)

    Advertiser ID of this creative. This is a required field.

  • creative_asset_metadata_object (Google::Apis::DfareportingV3_4::CreativeAssetMetadata) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2355

def insert_creative_asset(profile_id, advertiser_id,  = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options)
  else
    command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeAssetMetadata::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeAssetMetadata::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeField

Inserts a new creative field.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_object (Google::Apis::DfareportingV3_4::CreativeField) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2693

def insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldValue

Inserts a new creative field value.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    Creative field ID for this creative field value.

  • creative_field_value_object (Google::Apis::DfareportingV3_4::CreativeFieldValue) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2467

def insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeGroup

Inserts a new creative group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_group_object (Google::Apis::DfareportingV3_4::CreativeGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2886

def insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DirectorySite

Inserts a new directory site.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • directory_site_object (Google::Apis::DfareportingV3_4::DirectorySite) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3374

def insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options)
  command.request_representation = Google::Apis::DfareportingV3_4::DirectorySite::Representation
  command.request_object = directory_site_object
  command.response_representation = Google::Apis::DfareportingV3_4::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DynamicTargetingKey

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • dynamic_targeting_key_object (Google::Apis::DfareportingV3_4::DynamicTargetingKey) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3523

def insert_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/dynamicTargetingKeys', options)
  command.request_representation = Google::Apis::DfareportingV3_4::DynamicTargetingKey::Representation
  command.request_object = dynamic_targeting_key_object
  command.response_representation = Google::Apis::DfareportingV3_4::DynamicTargetingKey::Representation
  command.response_class = Google::Apis::DfareportingV3_4::DynamicTargetingKey
  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?
  execute_or_queue_command(command, &block)
end

#insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::EventTag

Inserts a new event tag.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • event_tag_object (Google::Apis::DfareportingV3_4::EventTag) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3662

def insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivity

Inserts a new floodlight activity.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_activity_object (Google::Apis::DfareportingV3_4::FloodlightActivity) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4025

def insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivityGroup

Inserts a new floodlight activity group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_activity_group_object (Google::Apis::DfareportingV3_4::FloodlightActivityGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4245

def insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Placement

Inserts a new placement.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_object (Google::Apis::DfareportingV3_4::Placement) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5717

def insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementGroup

Inserts a new placement group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_group_object (Google::Apis::DfareportingV3_4::PlacementGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5216

def insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementStrategy

Inserts a new placement strategy.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_strategy_object (Google::Apis::DfareportingV3_4::PlacementStrategy) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5487

def insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingList

Inserts a new remarketing list.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • remarketing_list_object (Google::Apis::DfareportingV3_4::RemarketingList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6310

def insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Report

Creates a report.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_object (Google::Apis::DfareportingV3_4::Report) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6537

def insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/reports', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Site

Inserts a new site.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • site_object (Google::Apis::DfareportingV3_4::Site) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6880

def insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Size

Inserts a new size.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • size_object (Google::Apis::DfareportingV3_4::Size) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7097

def insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/sizes', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Size::Representation
  command.request_object = size_object
  command.response_representation = Google::Apis::DfareportingV3_4::Size::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Subaccount

Inserts a new subaccount.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • subaccount_object (Google::Apis::DfareportingV3_4::Subaccount) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7208

def insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#insert_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetingTemplate

Inserts a new targeting template.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • targeting_template_object (Google::Apis::DfareportingV3_4::TargetingTemplate) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7487

def insert_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/targetingTemplates', options)
  command.request_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetingTemplate
  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?
  execute_or_queue_command(command, &block)
end

#insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRole

Inserts a new user role.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • user_role_object (Google::Apis::DfareportingV3_4::UserRole) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7896

def insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#list_account_permission_groups(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountPermissionGroupsListResponse

Retrieves the list of account permission groups.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



139
140
141
142
143
144
145
146
147
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 139

def (profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountPermissionGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AccountPermissionGroupsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_account_permissions(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountPermissionsListResponse

Retrieves the list of account permissions.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



202
203
204
205
206
207
208
209
210
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 202

def (profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountPermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AccountPermissionsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountUserProfilesListResponse

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • active (Boolean) (defaults to: nil)

    Select only active user profiles.

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

    Select only user profiles with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only user profiles with the specified subaccount ID.

  • user_role_id (Fixnum) (defaults to: nil)

    Select only user profiles with the specified user role ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 323

def (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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfilesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AccountUserProfilesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountsListResponse

Retrieves the list of accounts, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • active (Boolean) (defaults to: nil)

    Select only active accounts. Don't set this field to select both active and non-active accounts.

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

    Select only accounts with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 484

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/accounts', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AccountsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, 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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdsListResponse

Retrieves a list of ads, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • active (Boolean) (defaults to: nil)

    Select only active ads.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only ads with this advertiser ID.

  • archived (Boolean) (defaults to: nil)

    Select only archived ads.

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

    Select only ads with these audience segment IDs.

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

    Select only ads with these campaign IDs.

  • compatibility (String) (defaults to: nil)

    Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_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.

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

    Select only ads with these creative IDs assigned.

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

    Select only ads with these creative optimization configuration IDs.

  • dynamic_click_tracker (Boolean) (defaults to: nil)

    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.

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

    Select only ads with these IDs.

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

    Select only ads with these landing page IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • overridden_event_tag_id (Fixnum) (defaults to: nil)

    Select only ads with this event tag override ID.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

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

    Select only ads with these placement IDs assigned.

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

    Select only ads whose list targeting expression use these remarketing list IDs.

  • search_string (String) (defaults to: nil)

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

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

    Select only ads with these size IDs.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • ssl_compliant (Boolean) (defaults to: nil)

    Select only ads that are SSL-compliant.

  • ssl_required (Boolean) (defaults to: nil)

    Select only ads that require SSL.

  • type (Array<String>, String) (defaults to: nil)

    Select only ads with these types.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 714

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, 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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/ads', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AdsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AdsListResponse
  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['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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserGroupsListResponse

Retrieves a list of advertiser groups, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only advertiser groups with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 952

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AdvertiserGroupsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_advertiser_landing_pages(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: 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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse

Retrieves a list of landing pages.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only landing pages that belong to these advertisers.

  • archived (Boolean) (defaults to: nil)

    Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.

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

    Select only landing pages that are associated with these campaigns.

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

    Select only landing pages with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

    Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like " landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply " landingpage".

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only landing pages that belong to this subaccount.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1150

def list_advertiser_landing_pages(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: 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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse
  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['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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertisersListResponse

Retrieves a list of advertisers, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only advertisers with these advertiser group IDs.

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

    Select only advertisers with these floodlight configuration IDs.

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

    Select only advertisers with these IDs.

  • include_advertisers_without_groups_only (Boolean) (defaults to: nil)

    Select only advertisers which do not belong to any advertiser group.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • only_parent (Boolean) (defaults to: nil)

    Select only advertisers which use another advertiser's floodlight configuration.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • status (String) (defaults to: nil)

    Select only advertisers with the specified status.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only advertisers with these subaccount IDs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1357

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options)
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertisersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::AdvertisersListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_browsers(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::BrowsersListResponse

Retrieves a list of browsers.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1468
1469
1470
1471
1472
1473
1474
1475
1476
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1468

def list_browsers(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/browsers', options)
  command.response_representation = Google::Apis::DfareportingV3_4::BrowsersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::BrowsersListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CampaignCreativeAssociationsListResponse

Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • campaign_id (Fixnum)

    Campaign ID in this association.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1545

def list_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CampaignCreativeAssociationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CampaignCreativeAssociationsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CampaignsListResponse

Retrieves a list of campaigns, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only campaigns whose advertisers belong to these advertiser groups.

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

    Select only campaigns that belong to these advertisers.

  • archived (Boolean) (defaults to: nil)

    Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

  • at_least_one_optimization_activity (Boolean) (defaults to: nil)

    Select only campaigns that have at least one optimization activity.

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

    Exclude campaigns with these IDs.

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

    Select only campaigns with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • overridden_event_tag_id (Fixnum) (defaults to: nil)

    Select only campaigns that have overridden this event tag ID.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only campaigns that belong to this subaccount.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1677

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CampaignsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CampaignsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ChangeLogsListResponse

Retrieves a list of change logs. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • action (String) (defaults to: nil)

    Select only change logs with the specified action.

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

    Select only change logs with these IDs.

  • max_change_time (String) (defaults to: nil)

    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.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • min_change_time (String) (defaults to: nil)

    Select only change logs whose change time is after 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.

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

    Select only change logs with these object IDs.

  • object_type (String) (defaults to: nil)

    Select only change logs with the specified object type.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

    Select only change logs whose object ID, user name, old or new values match the search string.

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

    Select only change logs with these user profile IDs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1853

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ChangeLogsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ChangeLogsListResponse
  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'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CitiesListResponse

Retrieves a list of cities, possibly filtered.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only cities from these countries.

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

    Select only cities with these DART IDs.

  • name_prefix (String) (defaults to: nil)

    Select only cities with names starting with this prefix.

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

    Select only cities from these regions.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1901

def list_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/cities', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CitiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CitiesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_connection_types(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ConnectionTypesListResponse

Retrieves a list of connection types.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1968
1969
1970
1971
1972
1973
1974
1975
1976
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1968

def list_connection_types(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ConnectionTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ConnectionTypesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ContentCategoriesListResponse

Retrieves a list of content categories, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only content categories with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2114

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ContentCategoriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ContentCategoriesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_countries(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CountriesListResponse

Retrieves a list of countries.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2318

def list_countries(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/countries', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CountriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CountriesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldValuesListResponse

Retrieves a list of creative field values, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    Creative field ID for this creative field value.

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

    Select only creative field values with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

    Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2516

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValuesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CreativeFieldValuesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldsListResponse

Retrieves a list of creative fields, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only creative fields that belong to these advertisers.

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

    Select only creative fields with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2746

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CreativeFieldsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeGroupsListResponse

Retrieves a list of creative groups, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only creative groups that belong to these advertisers.

  • group_number (Fixnum) (defaults to: nil)

    Select only creative groups that belong to this subgroup.

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

    Select only creative groups with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2941

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CreativeGroupsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativesListResponse

Retrieves a list of creatives, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • active (Boolean) (defaults to: nil)

    Select only active creatives. Leave blank to select active and inactive creatives.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only creatives with this advertiser ID.

  • archived (Boolean) (defaults to: nil)

    Select only archived creatives. Leave blank to select archived and unarchived creatives.

  • campaign_id (Fixnum) (defaults to: nil)

    Select only creatives with this campaign ID.

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

    Select only in-stream video creatives with these companion IDs.

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

    Select only creatives with these creative field IDs.

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

    Select only creatives with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

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

    Select only creatives with these rendering IDs.

  • search_string (String) (defaults to: nil)

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

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

    Select only creatives with these size IDs.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • studio_creative_id (Fixnum) (defaults to: nil)

    Select only creatives corresponding to this Studio creative ID.

  • types (Array<String>, String) (defaults to: nil)

    Select only creatives with these creative types.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3153

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/creatives', options)
  command.response_representation = Google::Apis::DfareportingV3_4::CreativesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::CreativesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DirectorySitesListResponse

Retrieves a list of directory sites, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • accepts_in_stream_video_placements (Boolean) (defaults to: nil)

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_interstitial_placements (Boolean) (defaults to: nil)

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_publisher_paid_placements (Boolean) (defaults to: nil)

    Select only directory sites that accept publisher paid placements. This field can be left blank.

  • active (Boolean) (defaults to: nil)

    Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

  • dfp_network_code (String) (defaults to: nil)

    Select only directory sites with this Ad Manager network code.

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

    Select only directory sites with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3439

def list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options)
  command.response_representation = Google::Apis::DfareportingV3_4::DirectorySitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::DirectorySitesListResponse
  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['dfpNetworkCode'] = 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['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?
  execute_or_queue_command(command, &block)
end

#list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DynamicTargetingKeysListResponse

Retrieves a list of dynamic targeting keys.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only dynamic targeting keys whose object has this advertiser ID.

  • names (Array<String>, String) (defaults to: nil)

    Select only dynamic targeting keys exactly matching these names.

  • object_id_ (Fixnum) (defaults to: nil)

    Select only dynamic targeting keys with this object ID.

  • object_type (String) (defaults to: nil)

    Select only dynamic targeting keys with this object type.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3563

def list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options)
  command.response_representation = Google::Apis::DfareportingV3_4::DynamicTargetingKeysListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::DynamicTargetingKeysListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['names'] = names unless names.nil?
  command.query['objectId'] = object_id_ unless object_id_.nil?
  command.query['objectType'] = object_type unless object_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::EventTagsListResponse

Retrieves a list of event tags, possibly filtered.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • ad_id (Fixnum) (defaults to: nil)

    Select only event tags that belong to this ad.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only event tags that belong to this advertiser.

  • campaign_id (Fixnum) (defaults to: nil)

    Select only event tags that belong to this campaign.

  • definitions_only (Boolean) (defaults to: nil)

    Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

  • enabled (Boolean) (defaults to: nil)

    Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. 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.

  • event_tag_types (Array<String>, String) (defaults to: nil)

    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.

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

    Select only event tags with these IDs.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3732

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options)
  command.response_representation = Google::Apis::DfareportingV3_4::EventTagsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::EventTagsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FileList

Lists files for a user profile.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    The value of the nextToken from the previous result page.

  • scope (String) (defaults to: nil)

    The scope that defines which results are returned.

  • sort_field (String) (defaults to: nil)

    The field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3892

def list_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/files', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FileList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivitiesListResponse

Retrieves a list of floodlight activities, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

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

    Select only floodlight activities with the specified floodlight activity group IDs.

  • floodlight_activity_group_name (String) (defaults to: nil)

    Select only floodlight activities with the specified floodlight activity group name.

  • floodlight_activity_group_tag_string (String) (defaults to: nil)

    Select only floodlight activities with the specified floodlight activity group tag string.

  • floodlight_activity_group_type (String) (defaults to: nil)

    Select only floodlight activities with the specified floodlight activity group type.

  • floodlight_configuration_id (Fixnum) (defaults to: nil)

    Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

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

    Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • tag_string (String) (defaults to: nil)

    Select only floodlight activities with the specified tag string.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4099

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivitiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::FloodlightActivitiesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivityGroupsListResponse

Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

  • floodlight_configuration_id (Fixnum) (defaults to: nil)

    Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.

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

    Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • type (String) (defaults to: nil)

    Select only floodlight activity groups with the specified floodlight activity group type.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4309

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::FloodlightActivityGroupsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightConfigurationsListResponse

Retrieves a list of floodlight configurations, possibly filtered.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4454

def list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfigurationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::FloodlightConfigurationsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::InventoryItemsListResponse

Retrieves a list of inventory items, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for order documents.

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

    Select only inventory items with these IDs.

  • in_plan (Boolean) (defaults to: nil)

    Select only inventory items that are in plan.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

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

    Select only inventory items that belong to specified orders.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

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

    Select only inventory items that are associated with these sites.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • type (String) (defaults to: nil)

    Select only inventory items with this type.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4612

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, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options)
  command.response_representation = Google::Apis::DfareportingV3_4::InventoryItemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::InventoryItemsListResponse
  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['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_languages(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::LanguagesListResponse

Retrieves a list of languages.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4652
4653
4654
4655
4656
4657
4658
4659
4660
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4652

def list_languages(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/languages', options)
  command.response_representation = Google::Apis::DfareportingV3_4::LanguagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::LanguagesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_metros(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::MetrosListResponse

Retrieves a list of metros.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4682
4683
4684
4685
4686
4687
4688
4689
4690
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4682

def list_metros(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/metros', options)
  command.response_representation = Google::Apis::DfareportingV3_4::MetrosListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::MetrosListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_mobile_apps(profile_id, directories: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::MobileAppsListResponse

Retrieves list of available mobile apps.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • directories (Array<String>, String) (defaults to: nil)

    Select only apps from these directories.

  • ids (Array<String>, String) (defaults to: nil)

    Select only apps with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4760

def list_mobile_apps(profile_id, directories: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/mobileApps', options)
  command.response_representation = Google::Apis::DfareportingV3_4::MobileAppsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::MobileAppsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['directories'] = directories unless directories.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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_mobile_carriers(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::MobileCarriersListResponse

Retrieves a list of mobile carriers.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4828
4829
4830
4831
4832
4833
4834
4835
4836
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4828

def list_mobile_carriers(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options)
  command.response_representation = Google::Apis::DfareportingV3_4::MobileCarriersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::MobileCarriersListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_operating_system_versions(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OperatingSystemVersionsListResponse

Retrieves a list of operating system versions.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4891
4892
4893
4894
4895
4896
4897
4898
4899
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4891

def list_operating_system_versions(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OperatingSystemVersionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::OperatingSystemVersionsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_operating_systems(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OperatingSystemsListResponse

Retrieves a list of operating systems.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4954
4955
4956
4957
4958
4959
4960
4961
4962
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4954

def list_operating_systems(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OperatingSystemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::OperatingSystemsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OrderDocumentsListResponse

Retrieves a list of order documents, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for order documents.

  • approved (Boolean) (defaults to: nil)

    Select only order documents that have been approved by at least one user.

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

    Select only order documents with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

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

    Select only order documents for specified orders.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

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

    Select only order documents that are associated with these sites.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5047

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OrderDocumentsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::OrderDocumentsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::OrdersListResponse

Retrieves a list of orders, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • project_id (Fixnum)

    Project ID for orders.

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

    Select only orders with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

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

    Select only orders that are associated with these site IDs.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5144

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options)
  command.response_representation = Google::Apis::DfareportingV3_4::OrdersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::OrdersListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: 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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementGroupsListResponse

Retrieves a list of placement groups, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only placement groups that belong to these advertisers.

  • archived (Boolean) (defaults to: nil)

    Select only archived placements. Don't set this field to select both archived and non-archived placements.

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

    Select only placement groups that belong to these campaigns.

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

    Select only placement groups that are associated with these content categories.

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

    Select only placement groups that are associated with these directory sites.

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

    Select only placement groups with these IDs.

  • max_end_date (String) (defaults to: nil)

    Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • max_start_date (String) (defaults to: nil)

    Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

  • min_end_date (String) (defaults to: nil)

    Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

  • min_start_date (String) (defaults to: nil)

    Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • placement_group_type (String) (defaults to: nil)

    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.

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

    Select only placement groups that are associated with these placement strategies.

  • pricing_types (Array<String>, String) (defaults to: nil)

    Select only placement groups with these pricing types.

  • search_string (String) (defaults to: nil)

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

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

    Select only placement groups that are associated with these sites.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5304

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_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: 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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PlacementGroupsListResponse
  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'] =  unless .nil?
  command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['maxEndDate'] = max_end_date unless max_end_date.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['maxStartDate'] = max_start_date unless max_start_date.nil?
  command.query['minEndDate'] = min_end_date unless min_end_date.nil?
  command.query['minStartDate'] = min_start_date unless min_start_date.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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementStrategiesListResponse

Retrieves a list of placement strategies, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only placement strategies with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5538

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PlacementStrategiesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: 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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementsListResponse

Retrieves a list of placements, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only placements that belong to these advertisers.

  • archived (Boolean) (defaults to: nil)

    Select only archived placements. Don't set this field to select both archived and non-archived placements.

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

    Select only placements that belong to these campaigns.

  • compatibilities (Array<String>, String) (defaults to: nil)

    Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_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.

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

    Select only placements that are associated with these content categories.

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

    Select only placements that are associated with these directory sites.

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

    Select only placements that belong to these placement groups.

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

    Select only placements with these IDs.

  • max_end_date (String) (defaults to: nil)

    Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • max_start_date (String) (defaults to: nil)

    Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

  • min_end_date (String) (defaults to: nil)

    Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

  • min_start_date (String) (defaults to: nil)

    Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • payment_source (String) (defaults to: nil)

    Select only placements with this payment source.

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

    Select only placements that are associated with these placement strategies.

  • pricing_types (Array<String>, String) (defaults to: nil)

    Select only placements with these pricing types.

  • search_string (String) (defaults to: nil)

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

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

    Select only placements that are associated with these sites.

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

    Select only placements that are associated with these sizes.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5807

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_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: 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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/placements', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PlacementsListResponse
  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'] =  unless .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['maxEndDate'] = max_end_date unless max_end_date.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['maxStartDate'] = max_start_date unless max_start_date.nil?
  command.query['minEndDate'] = min_end_date unless min_end_date.nil?
  command.query['minStartDate'] = min_start_date unless min_start_date.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?
  execute_or_queue_command(command, &block)
end

#list_platform_types(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlatformTypesListResponse

Retrieves a list of platform types.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5961
5962
5963
5964
5965
5966
5967
5968
5969
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5961

def list_platform_types(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PlatformTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PlatformTypesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_postal_codes(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PostalCodesListResponse

Retrieves a list of postal codes.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6024
6025
6026
6027
6028
6029
6030
6031
6032
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6024

def list_postal_codes(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options)
  command.response_representation = Google::Apis::DfareportingV3_4::PostalCodesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::PostalCodesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ProjectsListResponse

Retrieves a list of projects, possibly filtered. This method supports paging .

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only projects with these advertiser IDs.

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

    Select only projects with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6106

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/projects', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ProjectsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::ProjectsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_regions(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RegionsListResponse

Retrieves a list of regions.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6143
6144
6145
6146
6147
6148
6149
6150
6151
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6143

def list_regions(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/regions', options)
  command.response_representation = Google::Apis::DfareportingV3_4::RegionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::RegionsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingListsListResponse

Retrieves a list of remarketing lists, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum)

    Select only remarketing lists owned by this advertiser.

  • active (Boolean) (defaults to: nil)

    Select only active or only inactive remarketing lists.

  • floodlight_activity_id (Fixnum) (defaults to: nil)

    Select only remarketing lists that have this floodlight activity ID.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • name (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6365

def list_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options)
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::RemarketingListsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FileList

Lists files for a report.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the parent report.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    The value of the nextToken from the previous result page.

  • sort_field (String) (defaults to: nil)

    The field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6811

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options)
  command.response_representation = Google::Apis::DfareportingV3_4::FileList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ReportList

Retrieves list of reports.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    The value of the nextToken from the previous result page.

  • scope (String) (defaults to: nil)

    The scope that defines which results are returned.

  • sort_field (String) (defaults to: nil)

    The field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6579

def list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/reports', options)
  command.response_representation = Google::Apis::DfareportingV3_4::ReportList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::SitesListResponse

Retrieves a list of sites, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • accepts_in_stream_video_placements (Boolean) (defaults to: nil)

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_interstitial_placements (Boolean) (defaults to: nil)

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_publisher_paid_placements (Boolean) (defaults to: nil)

    Select only sites that accept publisher paid placements.

  • ad_words_site (Boolean) (defaults to: nil)

    Select only AdWords sites.

  • approved (Boolean) (defaults to: nil)

    Select only approved sites.

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

    Select only sites with these campaign IDs.

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

    Select only sites with these directory site IDs.

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

    Select only sites with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only sites with this subaccount ID.

  • unmapped_site (Boolean) (defaults to: nil)

    Select only sites that have not been mapped to a directory site.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6949

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/sites', options)
  command.response_representation = Google::Apis::DfareportingV3_4::SitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::SitesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::SizesListResponse

Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • height (Fixnum) (defaults to: nil)

    Select only sizes with this height.

  • iab_standard (Boolean) (defaults to: nil)

    Select only IAB standard sizes.

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

    Select only sizes with these IDs.

  • width (Fixnum) (defaults to: nil)

    Select only sizes with this width.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7140

def list_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/sizes', options)
  command.response_representation = Google::Apis::DfareportingV3_4::SizesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::SizesListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::SubaccountsListResponse

Gets a list of subaccounts, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only subaccounts with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7257

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options)
  command.response_representation = Google::Apis::DfareportingV3_4::SubaccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::SubaccountsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetableRemarketingListsListResponse

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum)

    Select only targetable remarketing lists targetable by these advertisers.

  • active (Boolean) (defaults to: nil)

    Select only active or only inactive targetable remarketing lists.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • name (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7416

def list_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options)
  command.response_representation = Google::Apis::DfareportingV3_4::TargetableRemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetableRemarketingListsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_targeting_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetingTemplatesListResponse

Retrieves a list of targeting templates, optionally filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_id (Fixnum) (defaults to: nil)

    Select only targeting templates with this advertiser ID.

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

    Select only targeting templates with these IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 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 "template" will match objects with name "my template", "template 2015", or simply "template".

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7539

def list_targeting_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options)
  command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplatesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetingTemplatesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_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?
  execute_or_queue_command(command, &block)
end

#list_user_profiles(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserProfileList

Retrieves list of user profiles for a user.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7673
7674
7675
7676
7677
7678
7679
7680
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7673

def list_user_profiles(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserProfileList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::UserProfileList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRolePermissionGroupsListResponse

Gets a list of all supported user role permission groups.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7735
7736
7737
7738
7739
7740
7741
7742
7743
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7735

def list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRolePermissionGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::UserRolePermissionGroupsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRolePermissionsListResponse

Gets a list of user role permissions, possibly filtered.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Select only user role permissions with these IDs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7800

def list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRolePermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::UserRolePermissionsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#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, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRolesListResponse

Retrieves a list of user roles, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • account_user_role_only (Boolean) (defaults to: nil)

    Select only account level user roles not associated with any specific subaccount.

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

    Select only user roles with the specified IDs.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    Value of the nextPageToken from the previous result page.

  • search_string (String) (defaults to: nil)

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

  • sort_field (String) (defaults to: nil)

    Field by which to sort the list.

  • sort_order (String) (defaults to: nil)

    Order of sorted results.

  • subaccount_id (Fixnum) (defaults to: nil)

    Select only user roles that belong to this subaccount.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7950

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, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options)
  command.response_representation = Google::Apis::DfareportingV3_4::UserRolesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::UserRolesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['accountUserRoleOnly'] =  unless .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?
  execute_or_queue_command(command, &block)
end

#list_video_formats(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::VideoFormatsListResponse

Lists available video formats.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8090
8091
8092
8093
8094
8095
8096
8097
8098
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 8090

def list_video_formats(profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options)
  command.response_representation = Google::Apis::DfareportingV3_4::VideoFormatsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_4::VideoFormatsListResponse
  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?
  execute_or_queue_command(command, &block)
end

#patch_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Account

Updates an existing account. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Account ID.

  • account_object (Google::Apis::DfareportingV3_4::Account) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



524
525
526
527
528
529
530
531
532
533
534
535
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 524

def (profile_id, id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountUserProfile

Updates an existing account user profile. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    AccountUserProfile ID.

  • account_user_profile_object (Google::Apis::DfareportingV3_4::AccountUserProfile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 365

def (profile_id, id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Ad

Updates an existing ad. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Ad ID.

  • ad_object (Google::Apis::DfareportingV3_4::Ad) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



770
771
772
773
774
775
776
777
778
779
780
781
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 770

def patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Advertiser

Updates an existing advertiser. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Advertiser ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1402

def patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserGroup

Updates an existing advertiser group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    AdvertiserGroup ID.

  • advertiser_group_object (Google::Apis::DfareportingV3_4::AdvertiserGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



991
992
993
994
995
996
997
998
999
1000
1001
1002
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 991

def patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::LandingPage

Updates an existing advertiser landing page. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    LandingPage ID.

  • landing_page_object (Google::Apis::DfareportingV3_4::LandingPage) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1194

def patch_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_4::LandingPage
  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?
  execute_or_queue_command(command, &block)
end

#patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Campaign

Updates an existing campaign. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Campaign ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1723

def patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ContentCategory

Updates an existing content category. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    ContentCategory ID.

  • content_category_object (Google::Apis::DfareportingV3_4::ContentCategory) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2153

def (profile_id, id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Creative

Updates an existing creative. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Creative ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3202

def patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeField

Updates an existing creative field. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    CreativeField ID.

  • creative_field_object (Google::Apis::DfareportingV3_4::CreativeField) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2786

def patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldValue

Updates an existing creative field value. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    CreativeField ID.

  • id (Fixnum)

    CreativeFieldValue ID.

  • creative_field_value_object (Google::Apis::DfareportingV3_4::CreativeFieldValue) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2558

def patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeGroup

Updates an existing creative group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    CreativeGroup ID.

  • creative_group_object (Google::Apis::DfareportingV3_4::CreativeGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2982

def patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::EventTag

Updates an existing event tag. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    EventTag ID.

  • event_tag_object (Google::Apis::DfareportingV3_4::EventTag) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3775

def patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivity

Updates an existing floodlight activity. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    FloodlightActivity ID.

  • floodlight_activity_object (Google::Apis::DfareportingV3_4::FloodlightActivity) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4145

def patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivityGroup

Updates an existing floodlight activity group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    FloodlightActivityGroup ID.

  • floodlight_activity_group_object (Google::Apis::DfareportingV3_4::FloodlightActivityGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4352

def patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightConfiguration

Updates an existing floodlight configuration. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    FloodlightConfiguration ID.

  • floodlight_configuration_object (Google::Apis::DfareportingV3_4::FloodlightConfiguration) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4489

def patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Placement

Updates an existing placement. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Placement ID.

  • placement_object (Google::Apis::DfareportingV3_4::Placement) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5862

def patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementGroup

Updates an existing placement group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    PlacementGroup ID.

  • placement_group_object (Google::Apis::DfareportingV3_4::PlacementGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5356

def patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementStrategy

Updates an existing placement strategy. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    PlacementStrategy ID.

  • placement_strategy_object (Google::Apis::DfareportingV3_4::PlacementStrategy) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5577

def patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingList

Updates an existing remarketing list. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    RemarketingList ID.

  • remarketing_list_object (Google::Apis::DfareportingV3_4::RemarketingList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6406

def patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_remarketing_list_share(profile_id, id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingListShare

Updates an existing remarketing list share. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    RemarketingList ID.

  • remarketing_list_share_object (Google::Apis::DfareportingV3_4::RemarketingListShare) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6210

def patch_remarketing_list_share(profile_id, id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options)
  command.request_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_4::RemarketingListShare
  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?
  execute_or_queue_command(command, &block)
end

#patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Report

Updates an existing report. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    The DFA user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • report_object (Google::Apis::DfareportingV3_4::Report) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6617

def patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Site

Updates an existing site. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Site ID.

  • site_object (Google::Apis::DfareportingV3_4::Site) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6997

def patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Subaccount

Updates an existing subaccount. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    Subaccount ID.

  • subaccount_object (Google::Apis::DfareportingV3_4::Subaccount) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7296

def patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetingTemplate

Updates an existing targeting template. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    TargetingTemplate ID.

  • targeting_template_object (Google::Apis::DfareportingV3_4::TargetingTemplate) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7579

def patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options)
  command.request_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetingTemplate
  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?
  execute_or_queue_command(command, &block)
end

#patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRole

Updates an existing user role. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • id (Fixnum)

    UserRole ID.

  • user_role_object (Google::Apis::DfareportingV3_4::UserRole) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7991

def patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::DimensionValueList

Retrieves list of report dimension values for a list of filters.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • dimension_value_request_object (Google::Apis::DfareportingV3_4::DimensionValueRequest) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil)

    Maximum number of results to return.

  • page_token (String) (defaults to: nil)

    The value of the nextToken from the previous result page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3306

def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options)
  command.request_representation = Google::Apis::DfareportingV3_4::DimensionValueRequest::Representation
  command.request_object = dimension_value_request_object
  command.response_representation = Google::Apis::DfareportingV3_4::DimensionValueList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CompatibleFields

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.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_object (Google::Apis::DfareportingV3_4::Report) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6725

def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_4::CompatibleFields::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::File

Runs a report.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • synchronous (Boolean) (defaults to: nil)

    If set and true, tries to run the report synchronously.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6654

def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options)
  command.response_representation = Google::Apis::DfareportingV3_4::File::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_account(profile_id, account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Account

Updates an existing account.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • account_object (Google::Apis::DfareportingV3_4::Account) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



558
559
560
561
562
563
564
565
566
567
568
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 558

def (profile_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/accounts', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AccountUserProfile

Updates an existing account user profile.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • account_user_profile_object (Google::Apis::DfareportingV3_4::AccountUserProfile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



399
400
401
402
403
404
405
406
407
408
409
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 399

def (profile_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Ad

Updates an existing ad.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • ad_object (Google::Apis::DfareportingV3_4::Ad) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



804
805
806
807
808
809
810
811
812
813
814
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 804

def update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

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

Updates an existing advertiser.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1436

def update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::AdvertiserGroup

Updates an existing advertiser group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • advertiser_group_object (Google::Apis::DfareportingV3_4::AdvertiserGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1025

def update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::LandingPage

Updates an existing landing page.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • landing_page_object (Google::Apis::DfareportingV3_4::LandingPage) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1228

def update_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_4::LandingPage
  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?
  execute_or_queue_command(command, &block)
end

#update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Campaign

Updates an existing campaign.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 1757

def update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::ContentCategory

Updates an existing content category.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • content_category_object (Google::Apis::DfareportingV3_4::ContentCategory) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2187

def (profile_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Creative

Updates an existing creative.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3236

def update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeField

Updates an existing creative field.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_object (Google::Apis::DfareportingV3_4::CreativeField) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2820

def update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeFieldValue

Updates an existing creative field value.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_field_id (Fixnum)

    Creative field ID for this creative field value.

  • creative_field_value_object (Google::Apis::DfareportingV3_4::CreativeFieldValue) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 2595

def update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::CreativeGroup

Updates an existing creative group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • creative_group_object (Google::Apis::DfareportingV3_4::CreativeGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3016

def update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::EventTag

Updates an existing event tag.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • event_tag_object (Google::Apis::DfareportingV3_4::EventTag) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 3809

def update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivity

Updates an existing floodlight activity.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_activity_object (Google::Apis::DfareportingV3_4::FloodlightActivity) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4179

def update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightActivityGroup

Updates an existing floodlight activity group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_activity_group_object (Google::Apis::DfareportingV3_4::FloodlightActivityGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4386

def update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::FloodlightConfiguration

Updates an existing floodlight configuration.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • floodlight_configuration_object (Google::Apis::DfareportingV3_4::FloodlightConfiguration) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 4523

def update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.request_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Placement

Updates an existing placement.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_object (Google::Apis::DfareportingV3_4::Placement) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5896

def update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementGroup

Updates an existing placement group.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_group_object (Google::Apis::DfareportingV3_4::PlacementGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5390

def update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::PlacementStrategy

Updates an existing placement strategy.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • placement_strategy_object (Google::Apis::DfareportingV3_4::PlacementStrategy) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 5611

def update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingList

Updates an existing remarketing list.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • remarketing_list_object (Google::Apis::DfareportingV3_4::RemarketingList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6440

def update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::RemarketingListShare

Updates an existing remarketing list share.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • remarketing_list_share_object (Google::Apis::DfareportingV3_4::RemarketingListShare) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6244

def update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options)
  command.request_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Report

Updates a report.

Parameters:

  • profile_id (Fixnum)

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum)

    The ID of the report.

  • report_object (Google::Apis::DfareportingV3_4::Report) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 6689

def update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Site

Updates an existing site.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • site_object (Google::Apis::DfareportingV3_4::Site) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7031

def update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::Subaccount

Updates an existing subaccount.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • subaccount_object (Google::Apis::DfareportingV3_4::Subaccount) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7330

def update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end

#update_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::TargetingTemplate

Updates an existing targeting template.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • targeting_template_object (Google::Apis::DfareportingV3_4::TargetingTemplate) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 7613

def update_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options)
  command.request_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_4::TargetingTemplate
  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?
  execute_or_queue_command(command, &block)
end

#update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_4::UserRole

Updates an existing user role.

Parameters:

  • profile_id (Fixnum)

    User profile ID associated with this request.

  • user_role_object (Google::Apis::DfareportingV3_4::UserRole) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
# File 'lib/google/apis/dfareporting_v3_4/service.rb', line 8025

def update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_4::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?
  execute_or_queue_command(command, &block)
end