Class: Google::Apis::DfareportingV2_6::DfareportingService

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

Overview

DCM/DFA Reporting And Trafficking API

Manages your DoubleClick Campaign Manager ad campaigns and reports.

Examples:

require 'google/apis/dfareporting_v2_6'

Dfareporting = Google::Apis::DfareportingV2_6 # 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

Constructor Details

#initialize ⇒ DfareportingService

Returns a new instance of DfareportingService.



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

def initialize
  super('https://www.googleapis.com/', 'dfareporting/v2.6/')
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_v2_6/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_v2_6/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_v2_6/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::DfareportingV2_6::ConversionsBatchInsertResponse

Inserts conversions.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2273

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

#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 (String) —

    User profile ID associated with this request.

  • id (String) —

    Advertiser group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



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

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

    User profile ID associated with this request.

  • id (String) —

    Content category ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



2024
2025
2026
2027
2028
2029
2030
2031
2032
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2024

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

    User profile ID associated with this request.

  • id (String) —

    Creative Field ID

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2699

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

    User profile ID associated with this request.

  • creative_field_id (String) —

    Creative field ID for this creative field value.

  • id (String) —

    Creative Field Value ID

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2438

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

    User profile ID associated with this request.

  • object_id_ (String) —

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

  • name (String) —

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

  • object_type (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3729

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

    User profile ID associated with this request.

  • id (String) —

    Event tag ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



3855
3856
3857
3858
3859
3860
3861
3862
3863
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3855

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

    User profile ID associated with this request.

  • id (String) —

    Floodlight activity ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



4224
4225
4226
4227
4228
4229
4230
4231
4232
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4224

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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing campaign landing page.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • campaign_id (String) —

    Landing page campaign ID.

  • id (String) —

    Landing page ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



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

def delete_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options)
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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 (String) —

    User profile ID associated with this request.

  • id (String) —

    Placement strategy ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



6051
6052
6053
6054
6055
6056
6057
6058
6059
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6051

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

    The DFA user profile ID.

  • report_id (String) —

    The ID of the report.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



7233
7234
7235
7236
7237
7238
7239
7240
7241
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7233

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

    User profile ID associated with this request.

  • id (String) —

    User role ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



8766
8767
8768
8769
8770
8771
8772
8773
8774
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8766

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

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

Generates a tag for a floodlight activity.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4260

def generate_floodlight_activity_tag(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::DfareportingV2_6::FloodlightActivitiesGenerateTagResponse::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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

#generate_placement_tags(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::DfareportingV2_6::GeneratePlacementsTagsResponse

Generates tags for a placement.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

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

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

    Generate tags for these placements.

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

    Tag formats to generate for these placements.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6305

def generate_placement_tags(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options)
  command.response_representation = Google::Apis::DfareportingV2_6::GeneratePlacementsTagsResponse::Representation
  command.response_class = Google::Apis::DfareportingV2_6::GeneratePlacementsTagsResponse
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['placementIds'] = placement_ids unless placement_ids.nil?
  command.query['tagFormats'] = tag_formats unless tag_formats.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets one account by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Account ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



488
489
490
491
492
493
494
495
496
497
498
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 488

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

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

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • summary_account_id (String) —

    Account ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one account permission by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Account permission ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one account permission group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Account permission group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one account user profile by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    User profile ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one ad by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Ad ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



667
668
669
670
671
672
673
674
675
676
677
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 667

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

Gets one advertiser by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Advertiser ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    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_v2_6/service.rb', line 1191

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

Gets one advertiser group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Advertiser group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::DfareportingV2_6::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV2_6::Campaign

Gets one campaign by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Campaign ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 1548

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

Gets one change log by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Change log ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one connection type by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Connection type ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 1951

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

Gets one content category by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Content category ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2060

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

Gets one country by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • dart_id (String) —

    Country DART ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2312

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

Gets one creative by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Creative ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3172

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

Gets one creative field by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Creative Field ID

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    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
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2735

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

Gets one creative field value by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • creative_field_id (String) —

    Creative field ID for this creative field value.

  • id (String) —

    Creative Field Value ID

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2477

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

Gets one creative group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Creative group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2952

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

Gets one directory site by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Directory site ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3563

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

Gets one directory site contact by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Directory site contact ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3461

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

Gets one event tag by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Event tag ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3891

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

Retrieves a report file by its report ID and file ID.

Parameters:

  • report_id (String) —

    The ID of the report.

  • file_id (String) —

    The ID of the report file.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4131

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

Gets one floodlight activity by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Floodlight activity ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4298

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

Gets one floodlight activity group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Floodlight activity Group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4542

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

Gets one floodlight configuration by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Floodlight configuration ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4773

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

Gets one inventory item by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • project_id (String) —

    Project ID for order documents.

  • id (String) —

    Inventory item ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 4932

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::DfareportingV2_6::InventoryItem::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV2_6::LandingPage

Gets one campaign landing page by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • campaign_id (String) —

    Landing page campaign ID.

  • id (String) —

    Landing page ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5077

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

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

Gets one mobile carrier by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Mobile carrier ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5351

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

Gets one operating system by DART ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • dart_id (String) —

    Operating system DART ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5497

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

Gets one operating system version by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Operating system version ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5424

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

Gets one order by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • project_id (String) —

    Project ID for orders.

  • id (String) —

    Order ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5684

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::DfareportingV2_6::Order::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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::DfareportingV2_6::OrderDocument

Gets one order document by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • project_id (String) —

    Project ID for order documents.

  • id (String) —

    Order document ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5572

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

Gets one placement by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Placement ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6345

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

Gets one placement group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Placement group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 5787

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

Gets one placement strategy by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Placement strategy ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6087

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

Gets one platform type by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Platform type ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6615

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

Gets one postal code by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • code (String) —

    Postal code ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6688

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

Gets one project by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Project ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6761

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

Gets one remarketing list by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Remarketing list ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7013

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

Gets one remarketing list share by remarketing list ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • remarketing_list_id (String) —

    Remarketing list ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 6895

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

Retrieves a report by its ID.

Parameters:

  • profile_id (String) —

    The DFA user profile ID.

  • report_id (String) —

    The ID of the report.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7269

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

Retrieves a report file.

Parameters:

  • profile_id (String) —

    The DFA profile ID.

  • report_id (String) —

    The ID of the report.

  • file_id (String) —

    The ID of the report file.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7562

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

Gets one site by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Site ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7656

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

Gets one size by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Size ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 7898

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

Gets one subaccount by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Subaccount ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Gets one remarketing list by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Remarketing list ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8234

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

Gets one targeting template by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    Targeting template ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8334

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::DfareportingV2_6::TargetingTemplate::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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::DfareportingV2_6::UserProfile

Gets one user profile by ID.

Parameters:

  • profile_id (String) —

    The user profile ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8548

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

Gets one user role by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    User role ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8802

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

Gets one user role permission by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    User role permission ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8690

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

Gets one user role permission group by ID.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • id (String) —

    User role permission group ID.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 8617

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

#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::DfareportingV2_6::AccountUserProfile

Inserts a new account user profile.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Inserts a new ad.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 704

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

Inserts a new advertiser.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    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_v2_6/service.rb', line 1228

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

Inserts a new advertiser group.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::DfareportingV2_6::AdvertiserGroup::Representation
  command.request_object = advertiser_group_object
  command.response_representation = Google::Apis::DfareportingV2_6::AdvertiserGroup::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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_campaign(profile_id, default_landing_page_name, default_landing_page_url, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DfareportingV2_6::Campaign

Inserts a new campaign.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • default_landing_page_name (String) —

    Default landing page name for this new campaign. Must be less than 256 characters long.

  • default_landing_page_url (String) —

    Default landing page URL for this new campaign.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 1590

def insert_campaign(profile_id, default_landing_page_name, default_landing_page_url, 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::DfareportingV2_6::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DfareportingV2_6::Campaign::Representation
  command.response_class = Google::Apis::DfareportingV2_6::Campaign
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['defaultLandingPageName'] = default_landing_page_name unless default_landing_page_name.nil?
  command.query['defaultLandingPageUrl'] = default_landing_page_url unless default_landing_page_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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::DfareportingV2_6::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 (String) —

    User profile ID associated with this request.

  • campaign_id (String) —

    Campaign ID in this association.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 1461

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

Inserts a new content category.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2097

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::DfareportingV2_6::ContentCategory::Representation
  command.request_object = content_category_object
  command.response_representation = Google::Apis::DfareportingV2_6::ContentCategory::Representation
  command.response_class = Google::Apis::DfareportingV2_6::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::DfareportingV2_6::Creative

Inserts a new creative.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3209

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

Inserts a new creative asset.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • advertiser_id (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    IO stream or filename containing content to upload

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

    Content type of the uploaded content.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2390

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

Inserts a new creative field.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2772

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

Inserts a new creative field value.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

  • creative_field_id (String) —

    Creative field ID for this creative field value.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2517

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

Inserts a new creative group.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 2989

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

Inserts a new directory site.

Parameters:

  • profile_id (String) —

    User profile ID associated with this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

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

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

    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
 
# File 'generated/google/apis/dfareporting_v2_6/service.rb', line 3600

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::DfareportingV2_6::DirectorySite::Representation
  command.request_object = directory_site_object
  command.response_representation = Google::Apis::DfareportingV2_6::DirectorySite::Representation
  command.response_class = Google::Apis::DfareportingV2_6::DirectorySite
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser