Class: Google::Apis::DfareportingV3_0::DfareportingService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dfareporting_v3_0/service.rb

Overview

DCM/DFA Reporting And Trafficking API

Manages your DoubleClick Campaign Manager ad campaigns and reports.

Examples:

require 'google/apis/dfareporting_v3_0'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DfareportingService

Returns a new instance of DfareportingService



51
52
53
54
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'dfareporting/v3.0/')
  @batch_path = 'batch/dfareporting/v3.0'
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.



38
39
40
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 38

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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



44
45
46
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

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

Inserts conversions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2493

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

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

Updates existing conversions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2531

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

#delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



940
941
942
943
944
945
946
947
948
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 940

def delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



2243
2244
2245
2246
2247
2248
2249
2250
2251
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2243

def delete_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



2958
2959
2960
2961
2962
2963
2964
2965
2966
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2958

def delete_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2696

def delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes an existing dynamic targeting key.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • object_id_ (Fixnum) —

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

  • name (String) —

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

  • object_type (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



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

def delete_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



4118
4119
4120
4121
4122
4123
4124
4125
4126
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4118

def delete_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



4488
4489
4490
4491
4492
4493
4494
4495
4496
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4488

def delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



6075
6076
6077
6078
6079
6080
6081
6082
6083
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6075

def delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes a report by its ID.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • report_id (Fixnum) —

    The ID of the report.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



7260
7261
7262
7263
7264
7265
7266
7267
7268
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7260

def delete_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    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:



8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8795

def delete_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Generates a tag for a floodlight activity.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_activity_id (Fixnum) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4524

def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Generates tags for a placement.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • campaign_id (Fixnum) —

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

  • placement_ids (Array<Fixnum>, Fixnum) —

    Generate tags for these placements.

  • tag_formats (Array<String>, String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6331

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

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

Gets one account by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Account ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



490
491
492
493
494
495
496
497
498
499
500
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 490

def (profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Account
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



82
83
84
85
86
87
88
89
90
91
92
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 82

def (profile_id, , fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountActiveAdSummary::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 193

def (profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountPermission::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountPermission
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



120
121
122
123
124
125
126
127
128
129
130
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 120

def (profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one ad by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Ad ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



669
670
671
672
673
674
675
676
677
678
679
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 669

def get_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Ad
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one advertiser by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Advertiser ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1415

def get_advertiser(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Advertiser
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



976
977
978
979
980
981
982
983
984
985
986
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 976

def get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_landing_page(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1191

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

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

Gets one campaign by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Campaign ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1774

def get_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Campaign
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ChangeLog::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ChangeLog
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2170

def get_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ConnectionType::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ConnectionType
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2279

def get_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ContentCategory
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2570

def get_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Country::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Country
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['dartId'] = dart_id unless dart_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one creative by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Creative ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3433

def get_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Creative
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2994

def get_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeField
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2735

def get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3212

def get_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3825

def get_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV3_0::DirectorySite
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::DirectorySiteContact

Gets one directory site contact by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Directory site contact ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3722

def get_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContact::Representation
  command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContact
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4154

def get_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_0::EventTag
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • download_dest (IO, String) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4395

def get_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command =  make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options)
  else
    command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DfareportingV3_0::File::Representation
  command.response_class = Google::Apis::DfareportingV3_0::File
  command.params['reportId'] = report_id unless report_id.nil?
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4562

def get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4807

def get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5039

def get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5198

def get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::InventoryItem::Representation
  command.response_class = Google::Apis::DfareportingV3_0::InventoryItem
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5373

def get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::MobileCarrier::Representation
  command.response_class = Google::Apis::DfareportingV3_0::MobileCarrier
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5519

def get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystem::Representation
  command.response_class = Google::Apis::DfareportingV3_0::OperatingSystem
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['dartId'] = dart_id unless dart_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5446

def get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation
  command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemVersion
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5707

def get_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Order::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Order
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one order document by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • project_id (Fixnum) —

    Project ID for order documents.

  • id (Fixnum) —

    Order document ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5594

def get_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OrderDocument::Representation
  command.response_class = Google::Apis::DfareportingV3_0::OrderDocument
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one placement by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Placement ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6371

def get_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Placement
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5810

def get_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6111

def get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6641

def get_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlatformType::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlatformType
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6714

def get_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PostalCode::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PostalCode
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['code'] = code unless code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one project by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Project ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6787

def get_project(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Project::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Project
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7039

def get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6921

def get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a report by its ID.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • report_id (Fixnum) —

    The ID of the report.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7296

def get_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Report
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a report file. This method supports media download.

Parameters:

  • profile_id (Fixnum) —

    The DFA profile ID.

  • report_id (Fixnum) —

    The ID of the report.

  • file_id (Fixnum) —

    The ID of the report file.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • download_dest (IO, String) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7589

def get_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command =  make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options)
  else
    command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DfareportingV3_0::File::Representation
  command.response_class = Google::Apis::DfareportingV3_0::File
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one site by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Site ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7683

def get_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Site
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one size by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Size ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Size
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one subaccount by ID.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Subaccount ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8048

def get_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Subaccount
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8261

def get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::TargetableRemarketingList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_targeting_template(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8362

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

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

Gets one user profile by ID.

Parameters:

  • profile_id (Fixnum) —

    The user profile ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8577

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

#get_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8831

def get_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRole
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8719

def get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermission::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRolePermission
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8646

def get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_video_format(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 9051

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

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

Inserts a new account user profile.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 303

def (profile_id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new ad.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 706

def insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Ad
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new advertiser.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1452

def insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Advertiser
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new advertiser group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1013

def insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new landing page.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1228

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

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

Inserts a new campaign.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1811

def insert_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Campaign
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • campaign_id (Fixnum) —

    Campaign ID in this association.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1686

def insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation
  command.request_object = campaign_creative_association_object
  command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new content category.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2316

def insert_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ContentCategory
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new creative.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3470

def insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Creative
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new creative asset.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2648

def insert_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options)
  else
    command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation
  command.request_object = creative_asset_metadata_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeAssetMetadata
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new creative field.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3031

def insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeField
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new creative field value.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_field_id (Fixnum) —

    Creative field ID for this creative field value.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2775

def insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new creative group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3249

def insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new directory site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3862

def insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options)
  command.request_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation
  command.request_object = directory_site_object
  command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV3_0::DirectorySite
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4032

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

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

Inserts a new event tag.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4191

def insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_0::EventTag
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new floodlight activity.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4599

def insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new floodlight activity group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4844

def insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new placement.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6408

def insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Placement
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new placement group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5847

def insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new placement strategy.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6148

def insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new remarketing list.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7076

def insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a report.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7333

def insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/reports', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Report
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7720

def insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Site
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new size.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7962

def insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/sizes', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Size::Representation
  command.request_object = size_object
  command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Size
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new subaccount.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8085

def insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Subaccount
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a new targeting template.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8399

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

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

Inserts a new user role.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8868

def insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRole
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the list of account permission groups.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



156
157
158
159
160
161
162
163
164
165
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 156

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

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

Retrieves the list of account permissions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



229
230
231
232
233
234
235
236
237
238
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 229

def (profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only active user profiles.

  • ids (Array<Fixnum>, Fixnum) —

    Select only user profiles with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • subaccount_id (Fixnum) —

    Select only user profiles with the specified subaccount ID.

  • user_role_id (Fixnum) —

    Select only user profiles with the specified user role ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 365

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

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

  • ids (Array<Fixnum>, Fixnum) —

    Select only accounts with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 546

def list_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/accounts', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only active ads.

  • advertiser_id (Fixnum) —

    Select only ads with this advertiser ID.

  • archived (Boolean) —

    Select only archived ads.

  • audience_segment_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these audience segment IDs.

  • campaign_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these campaign IDs.

  • compatibility (String) —

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

    Select only ads with these creative IDs assigned.

  • creative_optimization_configuration_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these creative optimization configuration IDs.

  • dynamic_click_tracker (Boolean) —

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

    Select only ads with these IDs.

  • landing_page_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these landing page IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • overridden_event_tag_id (Fixnum) —

    Select only ads with this event tag override ID.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • placement_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these placement IDs assigned.

  • remarketing_list_ids (Array<Fixnum>, Fixnum) —

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

  • search_string (String) —

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

  • size_ids (Array<Fixnum>, Fixnum) —

    Select only ads with these size IDs.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • ssl_compliant (Boolean) —

    Select only ads that are SSL-compliant.

  • ssl_required (Boolean) —

    Select only ads that require SSL.

  • type (Array<String>, String) —

    Select only ads with these types.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 801

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/ads', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AdsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only advertiser groups with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1069

def list_advertiser_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_landing_pages(profile_id, advertiser_ids: nil, archived: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse

Retrieves a list of landing pages.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_ids (Array<Fixnum>, Fixnum) —

    Select only landing pages that belong to these advertisers.

  • archived (Boolean) —

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

  • ids (Array<Fixnum>, Fixnum) —

    Select only landing pages with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • subaccount_id (Fixnum) —

    Select only landing pages that belong to this subaccount.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1290

def list_advertiser_landing_pages(profile_id, advertiser_ids: nil, archived: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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['ids'] = ids unless ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['searchString'] = search_string unless search_string.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['subaccountId'] = subaccount_id unless subaccount_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_advertisers(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only advertisers with these advertiser group IDs.

  • floodlight_configuration_ids (Array<Fixnum>, Fixnum) —

    Select only advertisers with these floodlight configuration IDs.

  • ids (Array<Fixnum>, Fixnum) —

    Select only advertisers with these IDs.

  • include_advertisers_without_groups_only (Boolean) —

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

  • max_results (Fixnum) —

    Maximum number of results to return.

  • only_parent (Boolean) —

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

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • status (String) —

    Select only advertisers with the specified status.

  • subaccount_id (Fixnum) —

    Select only advertisers with these subaccount IDs.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1520

def list_advertisers(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options)
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertisersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a list of browsers.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1646

def list_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/browsers', options)
  command.response_representation = Google::Apis::DfareportingV3_0::BrowsersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1733

def list_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only campaigns whose advertisers belong to these advertiser groups.

  • advertiser_ids (Array<Fixnum>, Fixnum) —

    Select only campaigns that belong to these advertisers.

  • archived (Boolean) —

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

  • at_least_one_optimization_activity (Boolean) —

    Select only campaigns that have at least one optimization activity.

  • excluded_ids (Array<Fixnum>, Fixnum) —

    Exclude campaigns with these IDs.

  • ids (Array<Fixnum>, Fixnum) —

    Select only campaigns with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • overridden_event_tag_id (Fixnum) —

    Select only campaigns that have overridden this event tag ID.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • subaccount_id (Fixnum) —

    Select only campaigns that belong to this subaccount.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1880

def list_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CampaignsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::ChangeLogsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • action (String) —

    Select only change logs with the specified action.

  • ids (Array<Fixnum>, Fixnum) —

    Select only change logs with these IDs.

  • max_change_time (String) —

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

    Maximum number of results to return.

  • min_change_time (String) —

    Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.

  • object_ids (Array<Fixnum>, Fixnum) —

    Select only change logs with these object IDs.

  • object_type (String) —

    Select only change logs with the specified object type.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • user_profile_ids (Array<Fixnum>, Fixnum) —

    Select only change logs with these user profile IDs.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2076

def list_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ChangeLogsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only cities from these countries.

  • dart_ids (Array<Fixnum>, Fixnum) —

    Select only cities with these DART IDs.

  • name_prefix (String) —

    Select only cities with names starting with this prefix.

  • region_dart_ids (Array<Fixnum>, Fixnum) —

    Select only cities from these regions.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2129

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

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

Retrieves a list of connection types.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2206

def list_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ConnectionTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only content categories with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2372

def list_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ContentCategoriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a list of countries.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2606

def list_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/countries', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CountriesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only creative field values with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2829

def list_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only creative fields that belong to these advertisers.

  • ids (Array<Fixnum>, Fixnum) —

    Select only creative fields with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

    Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like " creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3089

def list_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only creative groups that belong to these advertisers.

  • group_number (Fixnum) —

    Select only creative groups that belong to this subgroup.

  • ids (Array<Fixnum>, Fixnum) —

    Select only creative groups with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

    Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like " creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3309

def list_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only active creatives. Leave blank to select active and inactive creatives.

  • advertiser_id (Fixnum) —

    Select only creatives with this advertiser ID.

  • archived (Boolean) —

    Select only archived creatives. Leave blank to select archived and unarchived creatives.

  • campaign_id (Fixnum) —

    Select only creatives with this campaign ID.

  • companion_creative_ids (Array<Fixnum>, Fixnum) —

    Select only in-stream video creatives with these companion IDs.

  • creative_field_ids (Array<Fixnum>, Fixnum) —

    Select only creatives with these creative field IDs.

  • ids (Array<Fixnum>, Fixnum) —

    Select only creatives with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • rendering_ids (Array<Fixnum>, Fixnum) —

    Select only creatives with these rendering IDs.

  • search_string (String) —

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

  • size_ids (Array<Fixnum>, Fixnum) —

    Select only creatives with these size IDs.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • studio_creative_id (Fixnum) —

    Select only creatives corresponding to this Studio creative ID.

  • types (Array<String>, String) —

    Select only creatives with these creative types.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3546

def list_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/creatives', options)
  command.response_representation = Google::Apis::DfareportingV3_0::CreativesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse

Retrieves a list of directory site contacts, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • directory_site_ids (Array<Fixnum>, Fixnum) —

    Select only directory site contacts with these directory site IDs. This is a required field.

  • ids (Array<Fixnum>, Fixnum) —

    Select only directory site contacts with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

    Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3781

def list_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts', options)
  command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['searchString'] = search_string unless search_string.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_interstitial_placements (Boolean) —

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_publisher_paid_placements (Boolean) —

    Select only directory sites that accept publisher paid placements. This field can be left blank.

  • active (Boolean) —

    Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

  • country_id (Fixnum) —

    Select only directory sites with this country ID.

  • dfp_network_code (String) —

    Select only directory sites with this DFP network code.

  • ids (Array<Fixnum>, Fixnum) —

    Select only directory sites with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • parent_id (Fixnum) —

    Select only directory sites with this parent ID.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3936

def list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options)
  command.response_representation = Google::Apis::DfareportingV3_0::DirectorySitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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['countryId'] = country_id unless country_id.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['parentId'] = parent_id unless parent_id.nil?
  command.query['searchString'] = search_string unless search_string.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse

Retrieves a list of dynamic targeting keys.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_id (Fixnum) —

    Select only dynamic targeting keys whose object has this advertiser ID.

  • names (Array<String>, String) —

    Select only dynamic targeting keys exactly matching these names.

  • object_id_ (Fixnum) —

    Select only dynamic targeting keys with this object ID.

  • object_type (String) —

    Select only dynamic targeting keys with this object type.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4077

def list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options)
  command.response_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::EventTagsListResponse

Retrieves a list of event tags, possibly filtered.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • ad_id (Fixnum) —

    Select only event tags that belong to this ad.

  • advertiser_id (Fixnum) —

    Select only event tags that belong to this advertiser.

  • campaign_id (Fixnum) —

    Select only event tags that belong to this campaign.

  • definitions_only (Boolean) —

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

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

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

    Select only event tags with these IDs.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4266

def list_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options)
  command.response_representation = Google::Apis::DfareportingV3_0::EventTagsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FileList

Lists files for a user profile.

Parameters:

  • profile_id (Fixnum) —

    The DFA profile ID.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    The value of the nextToken from the previous result page.

  • scope (String) —

    The scope that defines which results are returned.

  • sort_field (String) —

    The field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4446

def list_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/files', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FileList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['scope'] = scope unless scope.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

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

    Select only floodlight activities with the specified floodlight activity group IDs.

  • floodlight_activity_group_name (String) —

    Select only floodlight activities with the specified floodlight activity group name.

  • floodlight_activity_group_tag_string (String) —

    Select only floodlight activities with the specified floodlight activity group tag string.

  • floodlight_activity_group_type (String) —

    Select only floodlight activities with the specified floodlight activity group type.

  • floodlight_configuration_id (Fixnum) —

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

    Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • tag_string (String) —

    Select only floodlight activities with the specified tag string.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4678

def list_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

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

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

    Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • type (String) —

    Select only floodlight activity groups with the specified floodlight activity group type.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4913

def list_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse

Retrieves a list of floodlight configurations, possibly filtered.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • ids (Array<Fixnum>, Fixnum) —

    Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5078

def list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only inventory items with these IDs.

  • in_plan (Boolean) —

    Select only inventory items that are in plan.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • order_id (Array<Fixnum>, Fixnum) —

    Select only inventory items that belong to specified orders.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • site_id (Array<Fixnum>, Fixnum) —

    Select only inventory items that are associated with these sites.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • type (String) —

    Select only inventory items with this type.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5256

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options)
  command.response_representation = Google::Apis::DfareportingV3_0::InventoryItemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::LanguagesListResponse

Retrieves a list of languages.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5301

def list_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/languages', options)
  command.response_representation = Google::Apis::DfareportingV3_0::LanguagesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::MetrosListResponse

Retrieves a list of metros.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5336

def list_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/metros', options)
  command.response_representation = Google::Apis::DfareportingV3_0::MetrosListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::MobileCarriersListResponse

Retrieves a list of mobile carriers.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5409

def list_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options)
  command.response_representation = Google::Apis::DfareportingV3_0::MobileCarriersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse

Retrieves a list of operating system versions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5482

def list_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::OperatingSystemsListResponse

Retrieves a list of operating systems.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5555

def list_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::OrderDocumentsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • project_id (Fixnum) —

    Project ID for order documents.

  • approved (Boolean) —

    Select only order documents that have been approved by at least one user.

  • ids (Array<Fixnum>, Fixnum) —

    Select only order documents with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • order_id (Array<Fixnum>, Fixnum) —

    Select only order documents for specified orders.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

    Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like " orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".

  • site_id (Array<Fixnum>, Fixnum) —

    Select only order documents that are associated with these sites.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5658

def list_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['approved'] = approved unless approved.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderId'] = order_id unless order_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['searchString'] = search_string unless search_string.nil?
  command.query['siteId'] = site_id unless site_id.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only orders with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • site_id (Array<Fixnum>, Fixnum) —

    Select only orders that are associated with these site IDs.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5765

def list_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options)
  command.response_representation = Google::Apis::DfareportingV3_0::OrdersListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PlacementGroupsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_ids (Array<Fixnum>, Fixnum) —

    Select only placement groups that belong to these advertisers.

  • archived (Boolean) —

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

  • campaign_ids (Array<Fixnum>, Fixnum) —

    Select only placement groups that belong to these campaigns.

  • content_category_ids (Array<Fixnum>, Fixnum) —

    Select only placement groups that are associated with these content categories.

  • directory_site_ids (Array<Fixnum>, Fixnum) —

    Select only placement groups that are associated with these directory sites.

  • ids (Array<Fixnum>, Fixnum) —

    Select only placement groups with these IDs.

  • max_end_date (String) —

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

    Maximum number of results to return.

  • max_start_date (String) —

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

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

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

    Value of the nextPageToken from the previous result page.

  • placement_group_type (String) —

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

    Select only placement groups that are associated with these placement strategies.

  • pricing_types (Array<String>, String) —

    Select only placement groups with these pricing types.

  • search_string (String) —

    Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like " placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".

  • site_ids (Array<Fixnum>, Fixnum) —

    Select only placement groups that are associated with these sites.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5940

def list_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil?
  command.query['archived'] = archived unless archived.nil?
  command.query['campaignIds'] = campaign_ids unless campaign_ids.nil?
  command.query['contentCategoryIds'] = 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only placement strategies with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6204

def list_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PlacementsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_ids (Array<Fixnum>, Fixnum) —

    Select only placements that belong to these advertisers.

  • archived (Boolean) —

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

  • campaign_ids (Array<Fixnum>, Fixnum) —

    Select only placements that belong to these campaigns.

  • compatibilities (Array<String>, String) —

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

    Select only placements that are associated with these content categories.

  • directory_site_ids (Array<Fixnum>, Fixnum) —

    Select only placements that are associated with these directory sites.

  • group_ids (Array<Fixnum>, Fixnum) —

    Select only placements that belong to these placement groups.

  • ids (Array<Fixnum>, Fixnum) —

    Select only placements with these IDs.

  • max_end_date (String) —

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

    Maximum number of results to return.

  • max_start_date (String) —

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

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

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

    Value of the nextPageToken from the previous result page.

  • payment_source (String) —

    Select only placements with this payment source.

  • placement_strategy_ids (Array<Fixnum>, Fixnum) —

    Select only placements that are associated with these placement strategies.

  • pricing_types (Array<String>, String) —

    Select only placements with these pricing types.

  • search_string (String) —

    Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".

  • site_ids (Array<Fixnum>, Fixnum) —

    Select only placements that are associated with these sites.

  • size_ids (Array<Fixnum>, Fixnum) —

    Select only placements that are associated with these sizes.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6503

def list_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/placements', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementsListResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil?
  command.query['archived'] = archived unless archived.nil?
  command.query['campaignIds'] = campaign_ids unless campaign_ids.nil?
  command.query['compatibilities'] = compatibilities unless compatibilities.nil?
  command.query['contentCategoryIds'] = 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PlatformTypesListResponse

Retrieves a list of platform types.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6677

def list_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PlatformTypesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PostalCodesListResponse

Retrieves a list of postal codes.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6750

def list_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options)
  command.response_representation = Google::Apis::DfareportingV3_0::PostalCodesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only projects with these advertiser IDs.

  • ids (Array<Fixnum>, Fixnum) —

    Select only projects with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6842

def list_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/projects', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ProjectsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::RegionsListResponse

Retrieves a list of regions.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6884

def list_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/regions', options)
  command.response_representation = Google::Apis::DfareportingV3_0::RegionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::RemarketingListsListResponse

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_id (Fixnum) —

    Select only remarketing lists owned by this advertiser.

  • active (Boolean) —

    Select only active or only inactive remarketing lists.

  • floodlight_activity_id (Fixnum) —

    Select only remarketing lists that have this floodlight activity ID.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • name (String) —

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

    Value of the nextPageToken from the previous result page.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7136

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options)
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FileList

Lists files for a report.

Parameters:

  • profile_id (Fixnum) —

    The DFA profile ID.

  • report_id (Fixnum) —

    The ID of the parent report.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    The value of the nextToken from the previous result page.

  • sort_field (String) —

    The field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7641

def list_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options)
  command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FileList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::ReportList

Retrieves list of reports.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    The value of the nextToken from the previous result page.

  • scope (String) —

    The scope that defines which results are returned.

  • sort_field (String) —

    The field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7380

def list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/reports', options)
  command.response_representation = Google::Apis::DfareportingV3_0::ReportList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ReportList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['scope'] = scope unless scope.nil?
  command.query['sortField'] = sort_field unless sort_field.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_interstitial_placements (Boolean) —

    This search filter is no longer supported and will have no effect on the results returned.

  • accepts_publisher_paid_placements (Boolean) —

    Select only sites that accept publisher paid placements.

  • ad_words_site (Boolean) —

    Select only AdWords sites.

  • approved (Boolean) —

    Select only approved sites.

  • campaign_ids (Array<Fixnum>, Fixnum) —

    Select only sites with these campaign IDs.

  • directory_site_ids (Array<Fixnum>, Fixnum) —

    Select only sites with these directory site IDs.

  • ids (Array<Fixnum>, Fixnum) —

    Select only sites with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • subaccount_id (Fixnum) —

    Select only sites with this subaccount ID.

  • unmapped_site (Boolean) —

    Select only sites that have not been mapped to a directory site.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7794

def list_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/sites', options)
  command.response_representation = Google::Apis::DfareportingV3_0::SitesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::SizesListResponse

Retrieves a list of sizes, possibly filtered.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • height (Fixnum) —

    Select only sizes with this height.

  • iab_standard (Boolean) —

    Select only IAB standard sizes.

  • ids (Array<Fixnum>, Fixnum) —

    Select only sizes with these IDs.

  • width (Fixnum) —

    Select only sizes with this width.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8007

def list_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/sizes', options)
  command.response_representation = Google::Apis::DfareportingV3_0::SizesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only subaccounts with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8139

def list_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options)
  command.response_representation = Google::Apis::DfareportingV3_0::SubaccountsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • advertiser_id (Fixnum) —

    Select only targetable remarketing lists targetable by these advertisers.

  • active (Boolean) —

    Select only active or only inactive targetable remarketing lists.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • name (String) —

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

    Value of the nextPageToken from the previous result page.

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8318

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options)
  command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only targeting templates with this advertiser ID.

  • ids (Array<Fixnum>, Fixnum) —

    Select only targeting templates with these IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8456

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options)
  command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::UserProfileList

Retrieves list of user profiles for a user.

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8610
8611
8612
8613
8614
8615
8616
8617
8618
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8610

def list_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserProfileList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserProfileList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse

Gets a list of all supported user role permission groups.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8682

def list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only user role permissions with these IDs.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8757

def list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Select only account level user roles not associated with any specific subaccount.

  • ids (Array<Fixnum>, Fixnum) —

    Select only user roles with the specified IDs.

  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    Value of the nextPageToken from the previous result page.

  • search_string (String) —

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

  • sort_field (String) —

    Field by which to sort the list.

  • sort_order (String) —

    Order of sorted results.

  • subaccount_id (Fixnum) —

    Select only user roles that belong to this subaccount.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8927

def list_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options)
  command.response_representation = Google::Apis::DfareportingV3_0::UserRolesListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::VideoFormatsListResponse

Lists available video formats.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 9087

def list_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options)
  command.response_representation = Google::Apis::DfareportingV3_0::VideoFormatsListResponse::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Account

Updates an existing account. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Account ID.

  • account_object (Google::Apis::DfareportingV3_0::Account) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 591

def (profile_id, id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Account
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    User profile ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 412

def (profile_id, id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Ad

Updates an existing ad. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Ad ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 862

def patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Ad
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Advertiser

Updates an existing advertiser. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Advertiser ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1570

def patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Advertiser
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::AdvertiserGroup

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Advertiser group ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1113

def patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::LandingPage

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Landing page ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1337

def patch_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Campaign

Updates an existing campaign. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Campaign ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1931

def patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Campaign
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::ContentCategory

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Content category ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2416

def patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ContentCategory
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Creative

Updates an existing creative. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Creative ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3600

def patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Creative
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::CreativeField

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Creative Field ID

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3134

def patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeField
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Creative field ID for this creative field value.

  • id (Fixnum) —

    Creative Field Value ID

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2876

def patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::CreativeGroup

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Creative group ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3355

def patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::EventTag

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Event tag ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4314

def patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_0::EventTag
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FloodlightActivity

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Floodlight activity ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4729

def patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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) —

    Floodlight activity Group ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4961

def patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FloodlightConfiguration

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Floodlight configuration ID.

  • floodlight_configuration_object (Google::Apis::DfareportingV3_0::FloodlightConfiguration) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5118

def patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Placement

Updates an existing placement. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Placement ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6563

def patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Placement
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PlacementGroup

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Placement group ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5997

def patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::PlacementStrategy

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Placement strategy ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6248

def patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::RemarketingList

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Remarketing list ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7182

def patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::RemarketingListShare

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • remarketing_list_id (Fixnum) —

    Remarketing list ID.

  • remarketing_list_share_object (Google::Apis::DfareportingV3_0::RemarketingListShare) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6961

def patch_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options)
  command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Report

Updates a report. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • report_id (Fixnum) —

    The ID of the report.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7423

def patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Report
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Site

Updates an existing site. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Site ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7847

def patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Site
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Subaccount

Updates an existing subaccount. This method supports patch semantics.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Subaccount ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8183

def patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Subaccount
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::TargetingTemplate

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    Targeting template ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8501

def patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options)
  command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::UserRole

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

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • id (Fixnum) —

    User role ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8973

def patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRole
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::DimensionValueList

Retrieves list of report dimension values for a list of filters.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • dimension_value_request_object (Google::Apis::DfareportingV3_0::DimensionValueRequest) (defaults to: nil)
  • max_results (Fixnum) —

    Maximum number of results to return.

  • page_token (String) —

    The value of the nextToken from the previous result page.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3681

def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options)
  command.request_representation = Google::Apis::DfareportingV3_0::DimensionValueRequest::Representation
  command.request_object = dimension_value_request_object
  command.response_representation = Google::Apis::DfareportingV3_0::DimensionValueList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::DimensionValueList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::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 DFA user profile ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7546

def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_0::CompatibleFields::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CompatibleFields
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::File

Runs a report.

Parameters:

  • profile_id (Fixnum) —

    The DFA profile ID.

  • report_id (Fixnum) —

    The ID of the report.

  • synchronous (Boolean) —

    If set and true, tries to run the report synchronously.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7465

def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options)
  command.response_representation = Google::Apis::DfareportingV3_0::File::Representation
  command.response_class = Google::Apis::DfareportingV3_0::File
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['synchronous'] = synchronous unless synchronous.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Account

Updates an existing account.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • account_object (Google::Apis::DfareportingV3_0::Account) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 630

def (profile_id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/accounts', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Account
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing account user profile.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 451

def (profile_id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing ad.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/ads', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.request_object = ad_object
  command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Ad
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing advertiser.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1609

def update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Advertiser
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing advertiser group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1152

def update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing landing page.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1376

def update_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/advertiserLandingPages', options)
  command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation
  command.request_object = landing_page_object
  command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing campaign.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 1970

def update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Campaign
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing content category.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2455

def update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options)
  command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV3_0::ContentCategory
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing creative.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3639

def update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/creatives', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Creative
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing creative field.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3173

def update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.request_object = creative_field_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeField
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing creative field value.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • creative_field_id (Fixnum) —

    Creative field ID for this creative field value.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 2918

def update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.request_object = creative_field_value_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing creative group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 3394

def update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.request_object = creative_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing event tag.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4353

def update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options)
  command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.request_object = event_tag_object
  command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation
  command.response_class = Google::Apis::DfareportingV3_0::EventTag
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing floodlight activity.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 4768

def update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.request_object = floodlight_activity_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing floodlight activity group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5000

def update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.request_object = floodlight_activity_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::FloodlightConfiguration

Updates an existing floodlight configuration.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • floodlight_configuration_object (Google::Apis::DfareportingV3_0::FloodlightConfiguration) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 5157

def update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options)
  command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation
  command.request_object = floodlight_configuration_object
  command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation
  command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing placement.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6602

def update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/placements', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.request_object = placement_object
  command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Placement
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing placement group.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6036

def update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.request_object = placement_group_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing placement strategy.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 6287

def update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options)
  command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.request_object = placement_strategy_object
  command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation
  command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing remarketing list.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7221

def update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options)
  command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.request_object = remarketing_list_object
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingList
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::RemarketingListShare

Updates an existing remarketing list share.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

  • remarketing_list_share_object (Google::Apis::DfareportingV3_0::RemarketingListShare) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7000

def update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options)
  command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation
  command.request_object = remarketing_list_share_object
  command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation
  command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV3_0::Report

Updates a report.

Parameters:

  • profile_id (Fixnum) —

    The DFA user profile ID.

  • report_id (Fixnum) —

    The ID of the report.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7505

def update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.request_object = report_object
  command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Report
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing site.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 7886

def update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/sites', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Site
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing subaccount.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8222

def update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options)
  command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.request_object = subaccount_object
  command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation
  command.response_class = Google::Apis::DfareportingV3_0::Subaccount
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing targeting template.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 8540

def update_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options)
  command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation
  command.request_object = targeting_template_object
  command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV3_0::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing user role.

Parameters:

  • profile_id (Fixnum) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
 
# File 'generated/google/apis/dfareporting_v3_0/service.rb', line 9012

def update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options)
  command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.request_object = user_role_object
  command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation
  command.response_class = Google::Apis::DfareportingV3_0::UserRole
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end