google-api-ruby-client/generated/google/apis/partners_v2/classes.rb

943 lines
35 KiB
Ruby

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PartnersV2
# Request message for LogUserEvent.
class LogUserEventRequest
include Google::Apis::Core::Hashable
# Common data that is in each API request.
# Corresponds to the JSON property `requestMetadata`
# @return [Google::Apis::PartnersV2::RequestMetadata]
attr_accessor :request_metadata
# The action that occurred.
# Corresponds to the JSON property `eventAction`
# @return [String]
attr_accessor :event_action
# The category the action belongs to.
# Corresponds to the JSON property `eventCategory`
# @return [String]
attr_accessor :event_category
# The scope of the event.
# Corresponds to the JSON property `eventScope`
# @return [String]
attr_accessor :event_scope
# List of event data for the event.
# Corresponds to the JSON property `eventDatas`
# @return [Array<Google::Apis::PartnersV2::EventData>]
attr_accessor :event_datas
# The URL where the event occurred.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
# A lead resource that represents an advertiser contact for a `Company`. These
# are usually generated via Google Partner Search (the advertiser portal).
# Corresponds to the JSON property `lead`
# @return [Google::Apis::PartnersV2::Lead]
attr_accessor :lead
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@request_metadata = args[:request_metadata] if args.key?(:request_metadata)
@event_action = args[:event_action] if args.key?(:event_action)
@event_category = args[:event_category] if args.key?(:event_category)
@event_scope = args[:event_scope] if args.key?(:event_scope)
@event_datas = args[:event_datas] if args.key?(:event_datas)
@url = args[:url] if args.key?(:url)
@lead = args[:lead] if args.key?(:lead)
end
end
# Common data that is in each API request.
class RequestMetadata
include Google::Apis::Core::Hashable
# Values to use instead of the user's respective defaults. These are only
# honored by whitelisted products.
# Corresponds to the JSON property `userOverrides`
# @return [Google::Apis::PartnersV2::UserOverrides]
attr_accessor :user_overrides
# Locale to use for the current request.
# Corresponds to the JSON property `locale`
# @return [String]
attr_accessor :locale
# Google Partners session ID.
# Corresponds to the JSON property `partnersSessionId`
# @return [String]
attr_accessor :partners_session_id
# Experiment IDs the current request belongs to.
# Corresponds to the JSON property `experimentIds`
# @return [Array<String>]
attr_accessor :experiment_ids
# Source of traffic for the current request.
# Corresponds to the JSON property `trafficSource`
# @return [Google::Apis::PartnersV2::TrafficSource]
attr_accessor :traffic_source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@user_overrides = args[:user_overrides] if args.key?(:user_overrides)
@locale = args[:locale] if args.key?(:locale)
@partners_session_id = args[:partners_session_id] if args.key?(:partners_session_id)
@experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
@traffic_source = args[:traffic_source] if args.key?(:traffic_source)
end
end
# Values to use instead of the user's respective defaults. These are only
# honored by whitelisted products.
class UserOverrides
include Google::Apis::Core::Hashable
# IP address to use instead of the user's geo-located IP address.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# Logged-in user ID to impersonate instead of the user's ID.
# Corresponds to the JSON property `userId`
# @return [String]
attr_accessor :user_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@user_id = args[:user_id] if args.key?(:user_id)
end
end
# Source of traffic for the current request.
class TrafficSource
include Google::Apis::Core::Hashable
# Identifier to indicate where the traffic comes from. An identifier has
# multiple letters created by a team which redirected the traffic to us.
# Corresponds to the JSON property `trafficSourceId`
# @return [String]
attr_accessor :traffic_source_id
# Second level identifier to indicate where the traffic comes from. An
# identifier has multiple letters created by a team which redirected the traffic
# to us.
# Corresponds to the JSON property `trafficSubId`
# @return [String]
attr_accessor :traffic_sub_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@traffic_source_id = args[:traffic_source_id] if args.key?(:traffic_source_id)
@traffic_sub_id = args[:traffic_sub_id] if args.key?(:traffic_sub_id)
end
end
# Key value data pair for an event.
class EventData
include Google::Apis::Core::Hashable
# Data type.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# Data values.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@values = args[:values] if args.key?(:values)
end
end
# A lead resource that represents an advertiser contact for a `Company`. These
# are usually generated via Google Partner Search (the advertiser portal).
class Lead
include Google::Apis::Core::Hashable
# ID of the lead.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Type of lead.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Email address of lead source.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# First name of lead source.
# Corresponds to the JSON property `givenName`
# @return [String]
attr_accessor :given_name
# Last name of lead source.
# Corresponds to the JSON property `familyName`
# @return [String]
attr_accessor :family_name
# Website URL of lead source.
# Corresponds to the JSON property `websiteUrl`
# @return [String]
attr_accessor :website_url
# Phone number of lead source.
# Corresponds to the JSON property `phoneNumber`
# @return [String]
attr_accessor :phone_number
# Comments lead source gave.
# Corresponds to the JSON property `comments`
# @return [String]
attr_accessor :comments
# List of reasons for using Google Partner Search and creating a lead.
# Corresponds to the JSON property `gpsMotivations`
# @return [Array<String>]
attr_accessor :gps_motivations
# Represents an amount of money with its currency type.
# Corresponds to the JSON property `minMonthlyBudget`
# @return [Google::Apis::PartnersV2::Money]
attr_accessor :min_monthly_budget
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@type = args[:type] if args.key?(:type)
@email = args[:email] if args.key?(:email)
@given_name = args[:given_name] if args.key?(:given_name)
@family_name = args[:family_name] if args.key?(:family_name)
@website_url = args[:website_url] if args.key?(:website_url)
@phone_number = args[:phone_number] if args.key?(:phone_number)
@comments = args[:comments] if args.key?(:comments)
@gps_motivations = args[:gps_motivations] if args.key?(:gps_motivations)
@min_monthly_budget = args[:min_monthly_budget] if args.key?(:min_monthly_budget)
end
end
# Represents an amount of money with its currency type.
class Money
include Google::Apis::Core::Hashable
# The 3-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# The whole units of the amount. For example if `currencyCode` is `"USD"`, then
# 1 unit is one US dollar.
# Corresponds to the JSON property `units`
# @return [String]
attr_accessor :units
# Number of nano (10^-9) units of the amount. The value must be between -999,999,
# 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be
# positive or zero. If `units` is zero, `nanos` can be positive, zero, or
# negative. If `units` is negative, `nanos` must be negative or zero. For
# example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@units = args[:units] if args.key?(:units)
@nanos = args[:nanos] if args.key?(:nanos)
end
end
# Response message for LogUserEvent.
class LogUserEventResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
end
end
# Common data that is in each API response.
class ResponseMetadata
include Google::Apis::Core::Hashable
# Debug information about this request.
# Corresponds to the JSON property `debugInfo`
# @return [Google::Apis::PartnersV2::DebugInfo]
attr_accessor :debug_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@debug_info = args[:debug_info] if args.key?(:debug_info)
end
end
# Debug information about this request.
class DebugInfo
include Google::Apis::Core::Hashable
# Info about the server that serviced this request.
# Corresponds to the JSON property `serverInfo`
# @return [String]
attr_accessor :server_info
# URL of the service that handled this request.
# Corresponds to the JSON property `serviceUrl`
# @return [String]
attr_accessor :service_url
# Server-side debug stack trace.
# Corresponds to the JSON property `serverTraceInfo`
# @return [String]
attr_accessor :server_trace_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@server_info = args[:server_info] if args.key?(:server_info)
@service_url = args[:service_url] if args.key?(:service_url)
@server_trace_info = args[:server_trace_info] if args.key?(:server_trace_info)
end
end
# Request message for LogClientMessage.
class LogMessageRequest
include Google::Apis::Core::Hashable
# Common data that is in each API request.
# Corresponds to the JSON property `requestMetadata`
# @return [Google::Apis::PartnersV2::RequestMetadata]
attr_accessor :request_metadata
# Message level of client message.
# Corresponds to the JSON property `level`
# @return [String]
attr_accessor :level
# Details about the client message.
# Corresponds to the JSON property `details`
# @return [String]
attr_accessor :details
# Map of client info, such as URL, browser navigator, browser platform, etc.
# Corresponds to the JSON property `clientInfo`
# @return [Hash<String,String>]
attr_accessor :client_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@request_metadata = args[:request_metadata] if args.key?(:request_metadata)
@level = args[:level] if args.key?(:level)
@details = args[:details] if args.key?(:details)
@client_info = args[:client_info] if args.key?(:client_info)
end
end
# Response message for LogClientMessage.
class LogMessageResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
end
end
# Response message for ListUserStates.
class ListUserStatesResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
# User's states.
# Corresponds to the JSON property `userStates`
# @return [Array<String>]
attr_accessor :user_states
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
@user_states = args[:user_states] if args.key?(:user_states)
end
end
# Response message for GetCompany.
class GetCompanyResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
# A company resource in the Google Partners API. Once certified, it qualifies
# for being searched by advertisers.
# Corresponds to the JSON property `company`
# @return [Google::Apis::PartnersV2::Company]
attr_accessor :company
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
@company = args[:company] if args.key?(:company)
end
end
# A company resource in the Google Partners API. Once certified, it qualifies
# for being searched by advertisers.
class Company
include Google::Apis::Core::Hashable
# The ID of the company.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The name of the company.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The list of localized info for the company.
# Corresponds to the JSON property `localizedInfos`
# @return [Array<Google::Apis::PartnersV2::LocalizedCompanyInfo>]
attr_accessor :localized_infos
# The list of company locations.
# Corresponds to the JSON property `locations`
# @return [Array<Google::Apis::PartnersV2::Location>]
attr_accessor :locations
# Represents an amount of money with its currency type.
# Corresponds to the JSON property `convertedMinMonthlyBudget`
# @return [Google::Apis::PartnersV2::Money]
attr_accessor :converted_min_monthly_budget
# Represents an amount of money with its currency type.
# Corresponds to the JSON property `originalMinMonthlyBudget`
# @return [Google::Apis::PartnersV2::Money]
attr_accessor :original_min_monthly_budget
# Basic information from a public profile.
# Corresponds to the JSON property `publicProfile`
# @return [Google::Apis::PartnersV2::PublicProfile]
attr_accessor :public_profile
# The list of Google Partners certification statuses for the company.
# Corresponds to the JSON property `certificationStatuses`
# @return [Array<Google::Apis::PartnersV2::CertificationStatus>]
attr_accessor :certification_statuses
# Information related to the ranking of the company within the list of companies.
# Corresponds to the JSON property `ranks`
# @return [Array<Google::Apis::PartnersV2::Rank>]
attr_accessor :ranks
# URL of the company's website.
# Corresponds to the JSON property `websiteUrl`
# @return [String]
attr_accessor :website_url
# Industries the company can help with.
# Corresponds to the JSON property `industries`
# @return [Array<String>]
attr_accessor :industries
# Services the company can help with.
# Corresponds to the JSON property `services`
# @return [Array<String>]
attr_accessor :services
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@localized_infos = args[:localized_infos] if args.key?(:localized_infos)
@locations = args[:locations] if args.key?(:locations)
@converted_min_monthly_budget = args[:converted_min_monthly_budget] if args.key?(:converted_min_monthly_budget)
@original_min_monthly_budget = args[:original_min_monthly_budget] if args.key?(:original_min_monthly_budget)
@public_profile = args[:public_profile] if args.key?(:public_profile)
@certification_statuses = args[:certification_statuses] if args.key?(:certification_statuses)
@ranks = args[:ranks] if args.key?(:ranks)
@website_url = args[:website_url] if args.key?(:website_url)
@industries = args[:industries] if args.key?(:industries)
@services = args[:services] if args.key?(:services)
end
end
# The localized company information.
class LocalizedCompanyInfo
include Google::Apis::Core::Hashable
# Language code of the localized company info, as defined by BCP 47 (IETF BCP 47,
# "Tags for Identifying Languages").
# Corresponds to the JSON property `languageCode`
# @return [String]
attr_accessor :language_code
# Localized display name.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Localized brief description that the company uses to advertise themselves.
# Corresponds to the JSON property `overview`
# @return [String]
attr_accessor :overview
# List of country codes for the localized company info.
# Corresponds to the JSON property `countryCodes`
# @return [Array<String>]
attr_accessor :country_codes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@language_code = args[:language_code] if args.key?(:language_code)
@display_name = args[:display_name] if args.key?(:display_name)
@overview = args[:overview] if args.key?(:overview)
@country_codes = args[:country_codes] if args.key?(:country_codes)
end
end
# A location with address and geographic coordinates.
class Location
include Google::Apis::Core::Hashable
# The complete address of the location.
# Corresponds to the JSON property `address`
# @return [String]
attr_accessor :address
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the WGS84 standard. Values must be
# within normalized ranges. Example of normalization code in Python: def
# NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0,
# 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <=
# -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """
# Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.
# 0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360,
# NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(
# longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 ==
# NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (
# 0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-
# 360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -
# 170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(
# 90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0,
# -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
# NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.
# 0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
# Corresponds to the JSON property `latLng`
# @return [Google::Apis::PartnersV2::LatLng]
attr_accessor :lat_lng
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@address = args[:address] if args.key?(:address)
@lat_lng = args[:lat_lng] if args.key?(:lat_lng)
end
end
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the WGS84 standard. Values must be
# within normalized ranges. Example of normalization code in Python: def
# NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0,
# 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <=
# -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """
# Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.
# 0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360,
# NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(
# longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 ==
# NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (
# 0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-
# 360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -
# 170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(
# 90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0,
# -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
# NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.
# 0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
class LatLng
include Google::Apis::Core::Hashable
# The latitude in degrees. It must be in the range [-90.0, +90.0].
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
# The longitude in degrees. It must be in the range [-180.0, +180.0].
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] if args.key?(:latitude)
@longitude = args[:longitude] if args.key?(:longitude)
end
end
# Basic information from a public profile.
class PublicProfile
include Google::Apis::Core::Hashable
# The ID which can be used to retrieve more details about the public profile.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The display name of the public profile.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The URL of the public profile.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
# The URL to the main display image of the public profile.
# Corresponds to the JSON property `displayImageUrl`
# @return [String]
attr_accessor :display_image_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@display_name = args[:display_name] if args.key?(:display_name)
@url = args[:url] if args.key?(:url)
@display_image_url = args[:display_image_url] if args.key?(:display_image_url)
end
end
# Google Partners certification status.
class CertificationStatus
include Google::Apis::Core::Hashable
# The type of the certification.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# List of certification exam statuses.
# Corresponds to the JSON property `examStatuses`
# @return [Array<Google::Apis::PartnersV2::CertificationExamStatus>]
attr_accessor :exam_statuses
# Whether certification is passing.
# Corresponds to the JSON property `isCertified`
# @return [Boolean]
attr_accessor :is_certified
alias_method :is_certified?, :is_certified
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@exam_statuses = args[:exam_statuses] if args.key?(:exam_statuses)
@is_certified = args[:is_certified] if args.key?(:is_certified)
end
end
# Status for a Google Partners certification exam.
class CertificationExamStatus
include Google::Apis::Core::Hashable
# The type of certification exam.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The number of people who have passed the certification exam.
# Corresponds to the JSON property `numberUsersPass`
# @return [Fixnum]
attr_accessor :number_users_pass
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@number_users_pass = args[:number_users_pass] if args.key?(:number_users_pass)
end
end
# Information related to ranking of results.
class Rank
include Google::Apis::Core::Hashable
# The type of rank.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The numerical value of the rank.
# Corresponds to the JSON property `value`
# @return [Float]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
end
end
# Response message for ListCompanies.
class ListCompaniesResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
# The list of companies.
# Corresponds to the JSON property `companies`
# @return [Array<Google::Apis::PartnersV2::Company>]
attr_accessor :companies
# A token to retrieve next page of results. Pass this value in the `
# ListCompaniesRequest.page_token` field in the subsequent call to ListCompanies
# to retrieve the next page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
@companies = args[:companies] if args.key?(:companies)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for CreateLead.
class CreateLeadRequest
include Google::Apis::Core::Hashable
# Common data that is in each API request.
# Corresponds to the JSON property `requestMetadata`
# @return [Google::Apis::PartnersV2::RequestMetadata]
attr_accessor :request_metadata
# A lead resource that represents an advertiser contact for a `Company`. These
# are usually generated via Google Partner Search (the advertiser portal).
# Corresponds to the JSON property `lead`
# @return [Google::Apis::PartnersV2::Lead]
attr_accessor :lead
# reCaptcha challenge info.
# Corresponds to the JSON property `recaptchaChallenge`
# @return [Google::Apis::PartnersV2::RecaptchaChallenge]
attr_accessor :recaptcha_challenge
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@request_metadata = args[:request_metadata] if args.key?(:request_metadata)
@lead = args[:lead] if args.key?(:lead)
@recaptcha_challenge = args[:recaptcha_challenge] if args.key?(:recaptcha_challenge)
end
end
# reCaptcha challenge info.
class RecaptchaChallenge
include Google::Apis::Core::Hashable
# The ID of the reCaptcha challenge.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The response to the reCaptcha challenge.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@response = args[:response] if args.key?(:response)
end
end
# Response message for CreateLead. Debug information about this request.
class CreateLeadResponse
include Google::Apis::Core::Hashable
# Common data that is in each API response.
# Corresponds to the JSON property `responseMetadata`
# @return [Google::Apis::PartnersV2::ResponseMetadata]
attr_accessor :response_metadata
# A lead resource that represents an advertiser contact for a `Company`. These
# are usually generated via Google Partner Search (the advertiser portal).
# Corresponds to the JSON property `lead`
# @return [Google::Apis::PartnersV2::Lead]
attr_accessor :lead
# The outcome of reCaptcha validation.
# Corresponds to the JSON property `recaptchaStatus`
# @return [String]
attr_accessor :recaptcha_status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@response_metadata = args[:response_metadata] if args.key?(:response_metadata)
@lead = args[:lead] if args.key?(:lead)
@recaptcha_status = args[:recaptcha_status] if args.key?(:recaptcha_status)
end
end
end
end
end