Class: Google::Apis::DfareportingV4::DfareportingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/dfareporting_v4/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_v4'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://dfareporting.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DfareportingService

Returns a new instance of DfareportingService.



48
49
50
51
52
53
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'dfareporting/v4/',
        client_name: 'google-apis-dfareporting_v4',
        client_version: Google::Apis::DfareportingV4::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



41
42
43
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



46
47
48
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 46

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::DfareportingV4::ConversionsBatchInsertResponse

Inserts conversions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • conversions_batch_insert_request_object (Google::Apis::DfareportingV4::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



2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2505

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::DfareportingV4::ConversionsBatchInsertRequest::Representation
  command.request_object = conversions_batch_insert_request_object
  command.response_representation = Google::Apis::DfareportingV4::ConversionsBatchInsertResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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

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

Updates existing conversions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • conversions_batch_update_request_object (Google::Apis::DfareportingV4::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



2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2538

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::DfareportingV4::ConversionsBatchUpdateRequest::Representation
  command.request_object = conversions_batch_update_request_object
  command.response_representation = Google::Apis::DfareportingV4::ConversionsBatchUpdateResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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



840
841
842
843
844
845
846
847
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 840

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



2285
2286
2287
2288
2289
2290
2291
2292
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2285

def delete_content_category(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



2915
2916
2917
2918
2919
2920
2921
2922
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2915

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



2683
2684
2685
2686
2687
2688
2689
2690
2691
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2683

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) —

    Required. 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) —

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



3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3741

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



3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3852

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



4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4182

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



5573
5574
5575
5576
5577
5578
5579
5580
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5573

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



6622
6623
6624
6625
6626
6627
6628
6629
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6622

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



8055
8056
8057
8058
8059
8060
8061
8062
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8055

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::DfareportingV4::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



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

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::DfareportingV4::FloodlightActivitiesGenerateTagResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5799

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::DfareportingV4::PlacementsGenerateTagsResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 435

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::DfareportingV4::Account::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 77

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::DfareportingV4::AccountActiveAdSummary::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 173

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::DfareportingV4::AccountPermission::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 110

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::DfareportingV4::AccountPermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 236

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::DfareportingV4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



594
595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 594

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::DfareportingV4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1307

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::DfareportingV4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



871
872
873
874
875
876
877
878
879
880
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 871

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::DfareportingV4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1105

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::DfareportingV4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV4::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_billing_profile(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingProfile

Gets one billing profile by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Billing 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



1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1588

def get_billing_profile(profile_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/billingProfiles/{+id}', options)
  command.response_representation = Google::Apis::DfareportingV4::BillingProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingProfile
  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::DfareportingV4::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



1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1866

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::DfareportingV4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2076

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::DfareportingV4::ChangeLog::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::ConnectionType::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

def get_content_category(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::DfareportingV4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2572

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::DfareportingV4::Country::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3335

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::DfareportingV4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2946

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::DfareportingV4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2717

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::DfareportingV4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3139

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::DfareportingV4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3594

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::DfareportingV4::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3883

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::DfareportingV4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4099

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::DfareportingV4::File::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4466

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::DfareportingV4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4673

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::DfareportingV4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4812

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::DfareportingV4::InventoryItem::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4967

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::DfareportingV4::MobileApp::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5050

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::DfareportingV4::MobileCarrier::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5176

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::DfareportingV4::OperatingSystem::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5113

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::DfareportingV4::OperatingSystemVersion::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5241

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::DfareportingV4::Order::Representation
  command.response_class = Google::Apis::DfareportingV4::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_placement(profile_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::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



5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5834

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::DfareportingV4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5334

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::DfareportingV4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5604

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::DfareportingV4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6078

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::DfareportingV4::PlatformType::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6141

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::DfareportingV4::PostalCode::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6204

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::DfareportingV4::Project::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6426

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::DfareportingV4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6323

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::DfareportingV4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6653

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::DfareportingV4::Report::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6912

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::DfareportingV4::File::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6996

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::DfareportingV4::Site::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7213

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::DfareportingV4::Size::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7324

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::DfareportingV4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7512

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::DfareportingV4::TargetableRemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7604

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::DfareportingV4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV4::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_tv_campaign_detail(profile_id, id, account_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::TvCampaignDetail

Gets one TvCampaignDetail by ID.

Parameters:

  • profile_id (Fixnum) —

    Required. User profile ID associated with this request.

  • id (String) —

    Required. TV Campaign ID.

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

    Required. Account 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



7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7798

def get_tv_campaign_detail(profile_id, id, account_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/tvCampaignDetails/{+id}', options)
  command.response_representation = Google::Apis::DfareportingV4::TvCampaignDetail::Representation
  command.response_class = Google::Apis::DfareportingV4::TvCampaignDetail
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['accountId'] =  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_user_profile(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::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



7867
7868
7869
7870
7871
7872
7873
7874
7875
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7867

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



8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8086

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::DfareportingV4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7989

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::DfareportingV4::UserRolePermission::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7926

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::DfareportingV4::UserRolePermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8281

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::DfareportingV4::VideoFormat::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::AccountUserProfile

Inserts a new account user profile.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • account_user_profile_object (Google::Apis::DfareportingV4::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



268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 268

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::DfareportingV4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Ad

Inserts a new ad.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • ad_object (Google::Apis::DfareportingV4::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



626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 626

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::DfareportingV4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Advertiser

Inserts a new advertiser.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_object (Google::Apis::DfareportingV4::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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1339

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::DfareportingV4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::AdvertiserGroup

Inserts a new advertiser group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_group_object (Google::Apis::DfareportingV4::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



903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 903

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::DfareportingV4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::LandingPage

Inserts a new landing page.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • landing_page_object (Google::Apis::DfareportingV4::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



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1137

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::DfareportingV4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV4::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_billing_assignment(profile_id, billing_profile_id, billing_assignment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingAssignment

Inserts a new billing assignment and returns the new assignment. Only one of advertiser_id or campaign_id is support per request. If the new assignment has no effect (assigning a campaign to the parent advertiser billing profile or assigning an advertiser to the account billing profile), no assignment will be returned.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • billing_profile_id (Fixnum) —

    Billing profile ID of this billing assignment.

  • billing_assignment_object (Google::Apis::DfareportingV4::BillingAssignment) (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



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1520

def insert_billing_assignment(profile_id, billing_profile_id, billing_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments', options)
  command.request_representation = Google::Apis::DfareportingV4::BillingAssignment::Representation
  command.request_object = billing_assignment_object
  command.response_representation = Google::Apis::DfareportingV4::BillingAssignment::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingAssignment
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['billingProfileId'] = billing_profile_id unless billing_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::DfareportingV4::Campaign

Inserts a new campaign.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • campaign_object (Google::Apis::DfareportingV4::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



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1898

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::DfareportingV4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1788

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::DfareportingV4::CampaignCreativeAssociation::Representation
  command.request_object = campaign_creative_association_object
  command.response_representation = Google::Apis::DfareportingV4::CampaignCreativeAssociation::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::ContentCategory

Inserts a new content category.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • content_category_object (Google::Apis::DfareportingV4::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



2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2348

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

Inserts a new creative.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_object (Google::Apis::DfareportingV4::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



3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3367

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::DfareportingV4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2640

def 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, &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::DfareportingV4::CreativeAssetMetadata::Representation
  command.request_object = creative_asset_metadata_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeAssetMetadata::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::CreativeField

Inserts a new creative field.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_field_object (Google::Apis::DfareportingV4::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



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2978

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::DfareportingV4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2752

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::DfareportingV4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::CreativeGroup

Inserts a new creative group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_group_object (Google::Apis::DfareportingV4::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



3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3171

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::DfareportingV4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::DirectorySite

Inserts a new directory site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • directory_site_object (Google::Apis::DfareportingV4::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



3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3626

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::DfareportingV4::DirectorySite::Representation
  command.request_object = directory_site_object
  command.response_representation = Google::Apis::DfareportingV4::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3776

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::DfareportingV4::DynamicTargetingKey::Representation
  command.request_object = dynamic_targeting_key_object
  command.response_representation = Google::Apis::DfareportingV4::DynamicTargetingKey::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::EventTag

Inserts a new event tag.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • event_tag_object (Google::Apis::DfareportingV4::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



3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3915

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::DfareportingV4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightActivity

Inserts a new floodlight activity.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_activity_object (Google::Apis::DfareportingV4::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



4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4278

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::DfareportingV4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightActivityGroup

Inserts a new floodlight activity group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_activity_group_object (Google::Apis::DfareportingV4::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



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4498

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::DfareportingV4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Placement

Inserts a new placement.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_object (Google::Apis::DfareportingV4::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



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5866

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::DfareportingV4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementGroup

Inserts a new placement group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_group_object (Google::Apis::DfareportingV4::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



5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5366

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::DfareportingV4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementStrategy

Inserts a new placement strategy.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_strategy_object (Google::Apis::DfareportingV4::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



5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5636

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::DfareportingV4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::RemarketingList

Inserts a new remarketing list.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • remarketing_list_object (Google::Apis::DfareportingV4::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



6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6458

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::DfareportingV4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Report

Creates a report.

Parameters:

  • profile_id (Fixnum) —

    The Campaign Manager 360 user profile ID.

  • report_object (Google::Apis::DfareportingV4::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



6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6685

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::DfareportingV4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV4::Report::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Site

Inserts a new site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • site_object (Google::Apis::DfareportingV4::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



7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7028

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::DfareportingV4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV4::Site::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Size

Inserts a new size.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • size_object (Google::Apis::DfareportingV4::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



7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7245

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::DfareportingV4::Size::Representation
  command.request_object = size_object
  command.response_representation = Google::Apis::DfareportingV4::Size::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Subaccount

Inserts a new subaccount.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • subaccount_object (Google::Apis::DfareportingV4::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



7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7356

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::DfareportingV4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::TargetingTemplate

Inserts a new targeting template.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • targeting_template_object (Google::Apis::DfareportingV4::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



7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7636

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::DfareportingV4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::UserRole

Inserts a new user role.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • user_role_object (Google::Apis::DfareportingV4::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



8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8118

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::DfareportingV4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



141
142
143
144
145
146
147
148
149
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 141

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::DfareportingV4::AccountPermissionGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



204
205
206
207
208
209
210
211
212
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 204

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::DfareportingV4::AccountPermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::AccountUserProfilesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::AccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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
746
747
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 716

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::DfareportingV4::AdsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::AdvertiserGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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_invoices(profile_id, advertiser_id, issue_month: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::AdvertiserInvoicesListResponse

Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_id (Fixnum) —

    Advertiser ID of this invoice.

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

    Month for which invoices are needed in the format YYYYMM. Required field

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1069

def list_advertiser_invoices(profile_id, advertiser_id, issue_month: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/advertisers/{+advertiserId}/invoices', options)
  command.response_representation = Google::Apis::DfareportingV4::AdvertiserInvoicesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::AdvertiserInvoicesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['issueMonth'] = issue_month unless issue_month.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

#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::DfareportingV4::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



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1196

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::DfareportingV4::AdvertiserLandingPagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1402

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::DfareportingV4::AdvertisersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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_billing_assignments(profile_id, billing_profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingAssignmentsListResponse

Retrieves a list of billing assignments.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • billing_profile_id (Fixnum) —

    Billing profile ID of this billing assignment.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1555

def list_billing_assignments(profile_id, billing_profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments', options)
  command.response_representation = Google::Apis::DfareportingV4::BillingAssignmentsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingAssignmentsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['billingProfileId'] = billing_profile_id unless billing_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_billing_profiles(profile_id, currency_code: nil, ids: nil, max_results: nil, name: nil, only_suggestion: nil, page_token: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingProfilesListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Select only billing profile with currency.

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

    Select only billing profile with these IDs.

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

    Maximum number of results to return.

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

    Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020" , "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile" , "profile 2021", or simply "profile".

  • only_suggestion (Boolean) (defaults to: nil) —

    Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API.

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

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

    Select only billing profile with the specified status.

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

    Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1647

def list_billing_profiles(profile_id, currency_code: nil, ids: nil, max_results: nil, name: nil, only_suggestion: nil, page_token: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/billingProfiles', options)
  command.response_representation = Google::Apis::DfareportingV4::BillingProfilesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingProfilesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['currency_code'] = currency_code unless currency_code.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['name'] = name unless name.nil?
  command.query['onlySuggestion'] = only_suggestion unless only_suggestion.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['status'] = status unless status.nil?
  command.query['subaccountIds'] = subaccount_ids unless subaccount_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_billing_rates(profile_id, billing_profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingRatesListResponse

Retrieves a list of billing rates. This method supports paging.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • billing_profile_id (Fixnum) —

    Billing profile ID of this billing rate.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1722

def list_billing_rates(profile_id, billing_profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingRates', options)
  command.response_representation = Google::Apis::DfareportingV4::BillingRatesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingRatesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['billingProfileId'] = billing_profile_id unless billing_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_browsers(profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::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



1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1753

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::DfareportingV4::BrowsersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1830

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::DfareportingV4::CampaignCreativeAssociationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1962

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::DfareportingV4::CampaignsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2138

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::DfareportingV4::ChangeLogsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2186

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::DfareportingV4::CitiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



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

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::DfareportingV4::ConnectionTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2399

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::DfareportingV4::ContentCategoriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2603
2604
2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2603

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::DfareportingV4::CountriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2801

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::DfareportingV4::CreativeFieldValuesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3031

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::DfareportingV4::CreativeFieldsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3226

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::DfareportingV4::CreativeGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3438

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::DfareportingV4::CreativesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3691

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::DfareportingV4::DirectorySitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3816

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::DfareportingV4::DynamicTargetingKeysListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3985

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::DfareportingV4::EventTagsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4145

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::DfareportingV4::FileList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4352

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::DfareportingV4::FloodlightActivitiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4562

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::DfareportingV4::FloodlightActivityGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4707

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::DfareportingV4::FloodlightConfigurationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4865

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::DfareportingV4::InventoryItemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4905
4906
4907
4908
4909
4910
4911
4912
4913
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4905

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::DfareportingV4::LanguagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



4935
4936
4937
4938
4939
4940
4941
4942
4943
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4935

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::DfareportingV4::MetrosListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5013

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::DfareportingV4::MobileAppsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5081
5082
5083
5084
5085
5086
5087
5088
5089
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5081

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::DfareportingV4::MobileCarriersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5144
5145
5146
5147
5148
5149
5150
5151
5152
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5144

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::DfareportingV4::OperatingSystemVersionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



5207
5208
5209
5210
5211
5212
5213
5214
5215
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5207

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::DfareportingV4::OperatingSystemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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_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::DfareportingV4::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



5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5294

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::DfareportingV4::OrdersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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, active_status: nil, advertiser_ids: 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::DfareportingV4::PlacementGroupsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Select only placements with these active statuses.

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

    Select only placement groups that belong to these advertisers.

  • 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



5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5453

def list_placement_groups(profile_id, active_status: nil, advertiser_ids: 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::DfareportingV4::PlacementGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::PlacementGroupsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['activeStatus'] = active_status unless active_status.nil?
  command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil?
  command.query['campaignIds'] = campaign_ids unless campaign_ids.nil?
  command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil?
  command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['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::DfareportingV4::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



5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5687

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::DfareportingV4::PlacementStrategiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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, active_status: nil, advertiser_ids: 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::DfareportingV4::PlacementsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Select only placements with these active statuses.

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

    Select only placements that belong to these advertisers.

  • 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



5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5955

def list_placements(profile_id, active_status: nil, advertiser_ids: 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::DfareportingV4::PlacementsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::PlacementsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['activeStatus'] = active_status unless active_status.nil?
  command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil?
  command.query['campaignIds'] = campaign_ids unless campaign_ids.nil?
  command.query['compatibilities'] = compatibilities unless compatibilities.nil?
  command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil?
  command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil?
  command.query['groupIds'] = group_ids unless group_ids.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['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::DfareportingV4::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



6109
6110
6111
6112
6113
6114
6115
6116
6117
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6109

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::DfareportingV4::PlatformTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6172
6173
6174
6175
6176
6177
6178
6179
6180
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6172

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::DfareportingV4::PostalCodesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6254

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::DfareportingV4::ProjectsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6291
6292
6293
6294
6295
6296
6297
6298
6299
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6291

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::DfareportingV4::RegionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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) —

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



6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6513

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::DfareportingV4::RemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6959

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::DfareportingV4::FileList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6727

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::DfareportingV4::ReportList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7097

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::DfareportingV4::SitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7288

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::DfareportingV4::SizesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7405

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::DfareportingV4::SubaccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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) —

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



7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7565

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::DfareportingV4::TargetableRemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7688

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::DfareportingV4::TargetingTemplatesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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_tv_campaign_summaries(profile_id, account_id: nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::TvCampaignSummariesListResponse

Retrieves a list of TV campaign summaries.

Parameters:

  • profile_id (Fixnum) —

    Required. User profile ID associated with this request.

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

    Required. Account ID associated with this request.

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

    Required. Search string to filter the list of TV campaign summaries. Matches any substring. 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:

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



7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7835

def list_tv_campaign_summaries(profile_id, account_id: nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles/{+profileId}/tvCampaignSummaries', options)
  command.response_representation = Google::Apis::DfareportingV4::TvCampaignSummariesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::TvCampaignSummariesListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['accountId'] =  unless .nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profiles(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::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



7895
7896
7897
7898
7899
7900
7901
7902
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7895

def list_user_profiles(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'userprofiles', options)
  command.response_representation = Google::Apis::DfareportingV4::UserProfileList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



7957
7958
7959
7960
7961
7962
7963
7964
7965
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7957

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::DfareportingV4::UserRolePermissionGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8022

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::DfareportingV4::UserRolePermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8172

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::DfareportingV4::UserRolesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



8312
8313
8314
8315
8316
8317
8318
8319
8320
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8312

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::DfareportingV4::VideoFormatsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Account

Updates an existing account. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Account ID.

  • account_object (Google::Apis::DfareportingV4::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



526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 526

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::DfareportingV4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV4::Account::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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) —

    Required. AccountUserProfile ID.

  • account_user_profile_object (Google::Apis::DfareportingV4::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



367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 367

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::DfareportingV4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Ad

Updates an existing ad. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. RemarketingList ID.

  • ad_object (Google::Apis::DfareportingV4::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



772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 772

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::DfareportingV4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Advertiser

Updates an existing advertiser. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Advertiser ID.

  • advertiser_object (Google::Apis::DfareportingV4::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



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1447

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::DfareportingV4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::AdvertiserGroup

Updates an existing advertiser group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Advertiser Group ID.

  • advertiser_group_object (Google::Apis::DfareportingV4::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



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 993

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::DfareportingV4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::LandingPage

Updates an existing landing page. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Landing Page ID.

  • landing_page_object (Google::Apis::DfareportingV4::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



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1239

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::DfareportingV4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Campaign

Updates an existing campaign. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Campaign ID.

  • campaign_object (Google::Apis::DfareportingV4::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



2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2008

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::DfareportingV4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::ContentCategory

Updates an existing content category. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. ContentCategory ID.

  • content_category_object (Google::Apis::DfareportingV4::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



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2438

def patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'userprofiles/{+profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV4::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Creative

Updates an existing creative. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Creative ID.

  • creative_object (Google::Apis::DfareportingV4::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



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

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::DfareportingV4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3071

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::DfareportingV4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2843

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::DfareportingV4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::CreativeGroup

Updates an existing creative group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Creative Group ID.

  • creative_group_object (Google::Apis::DfareportingV4::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



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

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::DfareportingV4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::EventTag

Updates an existing event tag. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. EventTag ID.

  • event_tag_object (Google::Apis::DfareportingV4::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



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4028

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::DfareportingV4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightActivity

Updates an existing floodlight activity. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. EventTag ID.

  • floodlight_activity_object (Google::Apis::DfareportingV4::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



4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4398

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::DfareportingV4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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) —

    Required. EventTag ID.

  • floodlight_activity_group_object (Google::Apis::DfareportingV4::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



4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4605

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::DfareportingV4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightConfiguration

Updates an existing floodlight configuration. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. EventTag ID.

  • floodlight_configuration_object (Google::Apis::DfareportingV4::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



4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4742

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::DfareportingV4::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Placement

Updates an existing placement. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Placement ID.

  • placement_object (Google::Apis::DfareportingV4::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



6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6010

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::DfareportingV4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementGroup

Updates an existing placement group. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Placement ID.

  • placement_group_object (Google::Apis::DfareportingV4::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



5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5505

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::DfareportingV4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementStrategy

Updates an existing placement strategy. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. PlacementStrategy ID.

  • placement_strategy_object (Google::Apis::DfareportingV4::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



5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5726

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::DfareportingV4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::RemarketingList

Updates an existing remarketing list. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. RemarketingList ID.

  • remarketing_list_object (Google::Apis::DfareportingV4::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



6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6554

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::DfareportingV4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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) —

    Required. RemarketingList ID.

  • remarketing_list_share_object (Google::Apis::DfareportingV4::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



6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6358

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::DfareportingV4::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Report

Updates an existing report. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    The Campaign Manager 360 user profile ID.

  • report_id (Fixnum) —

    The ID of the report.

  • report_object (Google::Apis::DfareportingV4::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



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

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::DfareportingV4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV4::Report::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Site

Updates an existing site. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Site ID.

  • site_object (Google::Apis::DfareportingV4::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



7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7145

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::DfareportingV4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV4::Site::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Subaccount

Updates an existing subaccount. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. Subaccount ID.

  • subaccount_object (Google::Apis::DfareportingV4::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



7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7444

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::DfareportingV4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::TargetingTemplate

Updates an existing targeting template. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. RemarketingList ID.

  • targeting_template_object (Google::Apis::DfareportingV4::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



7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7728

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::DfareportingV4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::UserRole

Updates an existing user role. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Required. UserRole ID.

  • user_role_object (Google::Apis::DfareportingV4::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



8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8213

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::DfareportingV4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3558

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::DfareportingV4::DimensionValueRequest::Representation
  command.request_object = dimension_value_request_object
  command.response_representation = Google::Apis::DfareportingV4::DimensionValueList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6873

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::DfareportingV4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV4::CompatibleFields::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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



6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6802

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::DfareportingV4::File::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Account

Updates an existing account.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • account_object (Google::Apis::DfareportingV4::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



560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 560

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::DfareportingV4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV4::Account::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::AccountUserProfile

Updates an existing account user profile.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • account_user_profile_object (Google::Apis::DfareportingV4::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



401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 401

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::DfareportingV4::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV4::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Ad

Updates an existing ad.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • ad_object (Google::Apis::DfareportingV4::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



806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 806

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::DfareportingV4::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV4::Ad::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Advertiser

Updates an existing advertiser.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_object (Google::Apis::DfareportingV4::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



1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1481

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::DfareportingV4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV4::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::AdvertiserGroup

Updates an existing advertiser group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_group_object (Google::Apis::DfareportingV4::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



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1027

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::DfareportingV4::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV4::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::LandingPage

Updates an existing landing page.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • landing_page_object (Google::Apis::DfareportingV4::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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1273

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::DfareportingV4::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV4::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV4::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_billing_profile(profile_id, billing_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV4::BillingProfile

Updates an existing billing profile.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • billing_profile_object (Google::Apis::DfareportingV4::BillingProfile) (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



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 1688

def update_billing_profile(profile_id, billing_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{+profileId}/billingProfiles', options)
  command.request_representation = Google::Apis::DfareportingV4::BillingProfile::Representation
  command.request_object = billing_profile_object
  command.response_representation = Google::Apis::DfareportingV4::BillingProfile::Representation
  command.response_class = Google::Apis::DfareportingV4::BillingProfile
  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::DfareportingV4::Campaign

Updates an existing campaign.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • campaign_object (Google::Apis::DfareportingV4::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



2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2042

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::DfareportingV4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV4::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::ContentCategory

Updates an existing content category.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • content_category_object (Google::Apis::DfareportingV4::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



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2472

def update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'userprofiles/{+profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV4::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV4::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Creative

Updates an existing creative.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_object (Google::Apis::DfareportingV4::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



3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3521

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::DfareportingV4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV4::Creative::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::CreativeField

Updates an existing creative field.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_field_object (Google::Apis::DfareportingV4::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



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3105

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::DfareportingV4::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 2880

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::DfareportingV4::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::CreativeGroup

Updates an existing creative group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_group_object (Google::Apis::DfareportingV4::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



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 3301

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::DfareportingV4::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV4::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::EventTag

Updates an existing event tag.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • event_tag_object (Google::Apis::DfareportingV4::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



4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4062

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::DfareportingV4::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV4::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightActivity

Updates an existing floodlight activity.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_activity_object (Google::Apis::DfareportingV4::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



4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4432

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::DfareportingV4::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightActivityGroup

Updates an existing floodlight activity group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_activity_group_object (Google::Apis::DfareportingV4::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



4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4639

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::DfareportingV4::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::FloodlightConfiguration

Updates an existing floodlight configuration.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_configuration_object (Google::Apis::DfareportingV4::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



4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 4776

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::DfareportingV4::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV4::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Placement

Updates an existing placement.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_object (Google::Apis::DfareportingV4::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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6044

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::DfareportingV4::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV4::Placement::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementGroup

Updates an existing placement group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_group_object (Google::Apis::DfareportingV4::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



5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5539

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::DfareportingV4::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::PlacementStrategy

Updates an existing placement strategy.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • placement_strategy_object (Google::Apis::DfareportingV4::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



5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 5760

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::DfareportingV4::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV4::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::RemarketingList

Updates an existing remarketing list.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • remarketing_list_object (Google::Apis::DfareportingV4::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



6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6588

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::DfareportingV4::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV4::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::RemarketingListShare

Updates an existing remarketing list share.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • remarketing_list_share_object (Google::Apis::DfareportingV4::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



6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6392

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::DfareportingV4::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV4::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::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::DfareportingV4::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



6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 6837

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::DfareportingV4::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV4::Report::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Site

Updates an existing site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • site_object (Google::Apis::DfareportingV4::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



7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7179

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::DfareportingV4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV4::Site::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::Subaccount

Updates an existing subaccount.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • subaccount_object (Google::Apis::DfareportingV4::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



7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7478

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::DfareportingV4::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV4::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::TargetingTemplate

Updates an existing targeting template.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • targeting_template_object (Google::Apis::DfareportingV4::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



7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 7762

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::DfareportingV4::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV4::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV4::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::DfareportingV4::UserRole

Updates an existing user role.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • user_role_object (Google::Apis::DfareportingV4::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



8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
 
# File 'lib/google/apis/dfareporting_v4/service.rb', line 8247

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::DfareportingV4::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV4::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV4::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