Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="partners_v2.html">Google Partners API</a> . <a href="partners_v2.v2.html">v2</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#getPartnersstatus">getPartnersstatus(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p> |
| 79 | <p class="firstline">Gets Partners Status of the logged in user's agency.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#updateCompanies">updateCompanies(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</a></code></p> |
| 82 | <p class="firstline">Update company.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#updateLeads">updateLeads(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</a></code></p> |
| 85 | <p class="firstline">Updates the specified lead.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="getPartnersstatus">getPartnersstatus(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code> |
| 89 | <pre>Gets Partners Status of the logged in user's agency. |
| 90 | Should only be called if the logged in user is the admin of the agency. |
| 91 | |
| 92 | Args: |
| 93 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 94 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 95 | An identifier has multiple letters created by a team which redirected the |
| 96 | traffic to us. |
| 97 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 98 | x__xgafv: string, V1 error format. |
| 99 | Allowed values |
| 100 | 1 - v1 error format |
| 101 | 2 - v2 error format |
| 102 | requestMetadata_locale: string, Locale to use for the current request. |
| 103 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 104 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 105 | An identifier has multiple letters created by a team which redirected the |
| 106 | traffic to us. |
| 107 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| 112 | { # Response message for |
| 113 | # GetPartnersStatus. |
| 114 | "responseMetadata": { # Common data that is in each API response. # Current response metadata. |
| 115 | "debugInfo": { # Debug information about this request. # Debug information about this request. |
| 116 | "serverTraceInfo": "A String", # Server-side debug stack trace. |
| 117 | "serviceUrl": "A String", # URL of the service that handled this request. |
| 118 | "serverInfo": "A String", # Info about the server that serviced this request. |
| 119 | }, |
| 120 | }, |
| 121 | }</pre> |
| 122 | </div> |
| 123 | |
| 124 | <div class="method"> |
| 125 | <code class="details" id="updateCompanies">updateCompanies(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</code> |
| 126 | <pre>Update company. |
| 127 | Should only be called within the context of an authorized logged in user. |
| 128 | |
| 129 | Args: |
| 130 | body: object, The request body. (required) |
| 131 | The object takes the form of: |
| 132 | |
| 133 | { # A company resource in the Google Partners API. Once certified, it qualifies |
| 134 | # for being searched by advertisers. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 135 | "companyTypes": [ # Company type labels listed on the company's profile. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 136 | "A String", |
| 137 | ], |
| 138 | "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner |
| 139 | # business. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 140 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 141 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 142 | # If `units` is positive, `nanos` must be positive or zero. |
| 143 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 144 | # If `units` is negative, `nanos` must be negative or zero. |
| 145 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 146 | "units": "A String", # The whole units of the amount. |
| 147 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 148 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 149 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 150 | "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get |
| 151 | # auto-approved for associating with this company. |
| 152 | "A String", |
| 153 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 154 | "specializationStatus": [ # The list of Google Partners specialization statuses for the company. |
| 155 | { # Agency specialization status |
| 156 | "badgeSpecialization": "A String", # The specialization this status is for. |
| 157 | "badgeSpecializationState": "A String", # State of agency specialization. |
| 158 | }, |
| 159 | ], |
| 160 | "ranks": [ # Information related to the ranking of the company within the list of |
| 161 | # companies. |
| 162 | { # Information related to ranking of results. |
| 163 | "type": "A String", # The type of rank. |
| 164 | "value": 3.14, # The numerical value of the rank. |
| 165 | }, |
| 166 | ], |
| 167 | "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 168 | "locations": [ # The list of all company locations. |
| 169 | # If set, must include the |
| 170 | # primary_location |
| 171 | # in the list. |
| 172 | { # A location with address and geographic coordinates. May optionally contain a |
| 173 | # detailed (multi-field) version of the address. |
| 174 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 175 | "addressLine": [ # The following address lines represent the most specific part of any |
| 176 | # address. |
| 177 | "A String", |
| 178 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 179 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 180 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 181 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 182 | # classification code for sorting mail. |
| 183 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 184 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 185 | # specified otherwise, this must conform to the |
| 186 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 187 | # standard</a>. Values must be within normalized ranges. |
| 188 | # |
| 189 | # Example of normalization code in Python: |
| 190 | # |
| 191 | # def NormalizeLongitude(longitude): |
| 192 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 193 | # q, r = divmod(longitude, 360.0) |
| 194 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 195 | # return r - 360.0 |
| 196 | # return r |
| 197 | # |
| 198 | # def NormalizeLatLng(latitude, longitude): |
| 199 | # """Wraps decimal degrees latitude and longitude to |
| 200 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 201 | # r = latitude % 360.0 |
| 202 | # if r <= 90.0: |
| 203 | # return r, NormalizeLongitude(longitude) |
| 204 | # elif r >= 270.0: |
| 205 | # return r - 360, NormalizeLongitude(longitude) |
| 206 | # else: |
| 207 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 208 | # |
| 209 | # assert 180.0 == NormalizeLongitude(180.0) |
| 210 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 211 | # assert -179.0 == NormalizeLongitude(181.0) |
| 212 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 213 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 214 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 215 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 216 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 217 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 218 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 219 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 220 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 221 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 222 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 223 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 224 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 225 | "locality": "A String", # Generally refers to the city/town portion of an address. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 226 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 227 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 228 | "address": "A String", # The single string version of the address. |
| 229 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 230 | }, |
| 231 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 232 | "id": "A String", # The ID of the company. |
| 233 | "badgeTier": "A String", # Partner badge tier |
| 234 | "services": [ # Services the company can help with. |
| 235 | "A String", |
| 236 | ], |
| 237 | "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges. |
| 238 | # These are stored as full URLs as entered by the user, but only the TLD will |
| 239 | # be used for the actual verification. |
| 240 | "A String", |
| 241 | ], |
| 242 | "profileStatus": "A String", # The public viewability status of the company's profile. |
| 243 | "industries": [ # Industries the company can help with. |
| 244 | "A String", |
| 245 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 246 | "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company. |
| 247 | # detailed (multi-field) version of the address. |
| 248 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 249 | "addressLine": [ # The following address lines represent the most specific part of any |
| 250 | # address. |
| 251 | "A String", |
| 252 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 253 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 254 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 255 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 256 | # classification code for sorting mail. |
| 257 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 258 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 259 | # specified otherwise, this must conform to the |
| 260 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 261 | # standard</a>. Values must be within normalized ranges. |
| 262 | # |
| 263 | # Example of normalization code in Python: |
| 264 | # |
| 265 | # def NormalizeLongitude(longitude): |
| 266 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 267 | # q, r = divmod(longitude, 360.0) |
| 268 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 269 | # return r - 360.0 |
| 270 | # return r |
| 271 | # |
| 272 | # def NormalizeLatLng(latitude, longitude): |
| 273 | # """Wraps decimal degrees latitude and longitude to |
| 274 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 275 | # r = latitude % 360.0 |
| 276 | # if r <= 90.0: |
| 277 | # return r, NormalizeLongitude(longitude) |
| 278 | # elif r >= 270.0: |
| 279 | # return r - 360, NormalizeLongitude(longitude) |
| 280 | # else: |
| 281 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 282 | # |
| 283 | # assert 180.0 == NormalizeLongitude(180.0) |
| 284 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 285 | # assert -179.0 == NormalizeLongitude(181.0) |
| 286 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 287 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 288 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 289 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 290 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 291 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 292 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 293 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 294 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 295 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 296 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 297 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 298 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 299 | "locality": "A String", # Generally refers to the city/town portion of an address. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 300 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 301 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 302 | "address": "A String", # The single string version of the address. |
| 303 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 304 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 305 | "websiteUrl": "A String", # URL of the company's website. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 306 | "certificationStatuses": [ # The list of Google Partners certification statuses for the company. |
| 307 | { # Google Partners certification status. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 308 | "isCertified": True or False, # Whether certification is passing. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 309 | "userCount": 42, # Number of people who are certified, |
| 310 | "type": "A String", # The type of the certification. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 311 | "examStatuses": [ # List of certification exam statuses. |
| 312 | { # Status for a Google Partners certification exam. |
| 313 | "numberUsersPass": 42, # The number of people who have passed the certification exam. |
| 314 | "type": "A String", # The type of certification exam. |
| 315 | }, |
| 316 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 317 | }, |
| 318 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 319 | "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile. |
| 320 | "url": "A String", # The URL of the public profile. |
| 321 | "profileImage": "A String", # The URL to the main profile image of the public profile. |
| 322 | "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated. |
| 323 | "displayName": "A String", # The display name of the public profile. |
| 324 | "id": "A String", # The ID which can be used to retrieve more details about the public profile. |
| 325 | }, |
| 326 | "localizedInfos": [ # The list of localized info for the company. |
| 327 | { # The localized company information. |
| 328 | "countryCodes": [ # List of country codes for the localized company info. |
| 329 | "A String", |
| 330 | ], |
| 331 | "languageCode": "A String", # Language code of the localized company info, as defined by |
| 332 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 333 | # (IETF BCP 47, "Tags for Identifying Languages"). |
| 334 | "displayName": "A String", # Localized display name. |
| 335 | "overview": "A String", # Localized brief description that the company uses to advertise themselves. |
| 336 | }, |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 337 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 338 | "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, |
| 339 | # converted to the requested currency code. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 340 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 341 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 342 | # If `units` is positive, `nanos` must be positive or zero. |
| 343 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 344 | # If `units` is negative, `nanos` must be negative or zero. |
| 345 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 346 | "units": "A String", # The whole units of the amount. |
| 347 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 348 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 349 | }, |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 350 | "primaryLanguageCode": "A String", # The primary language code of the company, as defined by |
| 351 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 352 | # (IETF BCP 47, "Tags for Identifying Languages"). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 353 | "name": "A String", # The name of the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 354 | } |
| 355 | |
| 356 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 357 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 358 | An identifier has multiple letters created by a team which redirected the |
| 359 | traffic to us. |
| 360 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 361 | x__xgafv: string, V1 error format. |
| 362 | Allowed values |
| 363 | 1 - v1 error format |
| 364 | 2 - v2 error format |
| 365 | requestMetadata_locale: string, Locale to use for the current request. |
| 366 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 367 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 368 | An identifier has multiple letters created by a team which redirected the |
| 369 | traffic to us. |
| 370 | updateMask: string, Standard field mask for the set of fields to be updated. |
| 371 | Required with at least 1 value in FieldMask's paths. |
| 372 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 373 | |
| 374 | Returns: |
| 375 | An object of the form: |
| 376 | |
| 377 | { # A company resource in the Google Partners API. Once certified, it qualifies |
| 378 | # for being searched by advertisers. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 379 | "companyTypes": [ # Company type labels listed on the company's profile. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 380 | "A String", |
| 381 | ], |
| 382 | "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner |
| 383 | # business. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 384 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 385 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 386 | # If `units` is positive, `nanos` must be positive or zero. |
| 387 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 388 | # If `units` is negative, `nanos` must be negative or zero. |
| 389 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 390 | "units": "A String", # The whole units of the amount. |
| 391 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 392 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 393 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 394 | "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get |
| 395 | # auto-approved for associating with this company. |
| 396 | "A String", |
| 397 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 398 | "specializationStatus": [ # The list of Google Partners specialization statuses for the company. |
| 399 | { # Agency specialization status |
| 400 | "badgeSpecialization": "A String", # The specialization this status is for. |
| 401 | "badgeSpecializationState": "A String", # State of agency specialization. |
| 402 | }, |
| 403 | ], |
| 404 | "ranks": [ # Information related to the ranking of the company within the list of |
| 405 | # companies. |
| 406 | { # Information related to ranking of results. |
| 407 | "type": "A String", # The type of rank. |
| 408 | "value": 3.14, # The numerical value of the rank. |
| 409 | }, |
| 410 | ], |
| 411 | "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 412 | "locations": [ # The list of all company locations. |
| 413 | # If set, must include the |
| 414 | # primary_location |
| 415 | # in the list. |
| 416 | { # A location with address and geographic coordinates. May optionally contain a |
| 417 | # detailed (multi-field) version of the address. |
| 418 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 419 | "addressLine": [ # The following address lines represent the most specific part of any |
| 420 | # address. |
| 421 | "A String", |
| 422 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 423 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 424 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 425 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 426 | # classification code for sorting mail. |
| 427 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 428 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 429 | # specified otherwise, this must conform to the |
| 430 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 431 | # standard</a>. Values must be within normalized ranges. |
| 432 | # |
| 433 | # Example of normalization code in Python: |
| 434 | # |
| 435 | # def NormalizeLongitude(longitude): |
| 436 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 437 | # q, r = divmod(longitude, 360.0) |
| 438 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 439 | # return r - 360.0 |
| 440 | # return r |
| 441 | # |
| 442 | # def NormalizeLatLng(latitude, longitude): |
| 443 | # """Wraps decimal degrees latitude and longitude to |
| 444 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 445 | # r = latitude % 360.0 |
| 446 | # if r <= 90.0: |
| 447 | # return r, NormalizeLongitude(longitude) |
| 448 | # elif r >= 270.0: |
| 449 | # return r - 360, NormalizeLongitude(longitude) |
| 450 | # else: |
| 451 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 452 | # |
| 453 | # assert 180.0 == NormalizeLongitude(180.0) |
| 454 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 455 | # assert -179.0 == NormalizeLongitude(181.0) |
| 456 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 457 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 458 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 459 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 460 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 461 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 462 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 463 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 464 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 465 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 466 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 467 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 468 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 469 | "locality": "A String", # Generally refers to the city/town portion of an address. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 470 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 471 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 472 | "address": "A String", # The single string version of the address. |
| 473 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 474 | }, |
| 475 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 476 | "id": "A String", # The ID of the company. |
| 477 | "badgeTier": "A String", # Partner badge tier |
| 478 | "services": [ # Services the company can help with. |
| 479 | "A String", |
| 480 | ], |
| 481 | "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges. |
| 482 | # These are stored as full URLs as entered by the user, but only the TLD will |
| 483 | # be used for the actual verification. |
| 484 | "A String", |
| 485 | ], |
| 486 | "profileStatus": "A String", # The public viewability status of the company's profile. |
| 487 | "industries": [ # Industries the company can help with. |
| 488 | "A String", |
| 489 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 490 | "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company. |
| 491 | # detailed (multi-field) version of the address. |
| 492 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 493 | "addressLine": [ # The following address lines represent the most specific part of any |
| 494 | # address. |
| 495 | "A String", |
| 496 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 497 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 498 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 499 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 500 | # classification code for sorting mail. |
| 501 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 502 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 503 | # specified otherwise, this must conform to the |
| 504 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 505 | # standard</a>. Values must be within normalized ranges. |
| 506 | # |
| 507 | # Example of normalization code in Python: |
| 508 | # |
| 509 | # def NormalizeLongitude(longitude): |
| 510 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 511 | # q, r = divmod(longitude, 360.0) |
| 512 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 513 | # return r - 360.0 |
| 514 | # return r |
| 515 | # |
| 516 | # def NormalizeLatLng(latitude, longitude): |
| 517 | # """Wraps decimal degrees latitude and longitude to |
| 518 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 519 | # r = latitude % 360.0 |
| 520 | # if r <= 90.0: |
| 521 | # return r, NormalizeLongitude(longitude) |
| 522 | # elif r >= 270.0: |
| 523 | # return r - 360, NormalizeLongitude(longitude) |
| 524 | # else: |
| 525 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 526 | # |
| 527 | # assert 180.0 == NormalizeLongitude(180.0) |
| 528 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 529 | # assert -179.0 == NormalizeLongitude(181.0) |
| 530 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 531 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 532 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 533 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 534 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 535 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 536 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 537 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 538 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 539 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 540 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 541 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 542 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 543 | "locality": "A String", # Generally refers to the city/town portion of an address. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 544 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 545 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 546 | "address": "A String", # The single string version of the address. |
| 547 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 548 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 549 | "websiteUrl": "A String", # URL of the company's website. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 550 | "certificationStatuses": [ # The list of Google Partners certification statuses for the company. |
| 551 | { # Google Partners certification status. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 552 | "isCertified": True or False, # Whether certification is passing. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 553 | "userCount": 42, # Number of people who are certified, |
| 554 | "type": "A String", # The type of the certification. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 555 | "examStatuses": [ # List of certification exam statuses. |
| 556 | { # Status for a Google Partners certification exam. |
| 557 | "numberUsersPass": 42, # The number of people who have passed the certification exam. |
| 558 | "type": "A String", # The type of certification exam. |
| 559 | }, |
| 560 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 561 | }, |
| 562 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 563 | "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile. |
| 564 | "url": "A String", # The URL of the public profile. |
| 565 | "profileImage": "A String", # The URL to the main profile image of the public profile. |
| 566 | "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated. |
| 567 | "displayName": "A String", # The display name of the public profile. |
| 568 | "id": "A String", # The ID which can be used to retrieve more details about the public profile. |
| 569 | }, |
| 570 | "localizedInfos": [ # The list of localized info for the company. |
| 571 | { # The localized company information. |
| 572 | "countryCodes": [ # List of country codes for the localized company info. |
| 573 | "A String", |
| 574 | ], |
| 575 | "languageCode": "A String", # Language code of the localized company info, as defined by |
| 576 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 577 | # (IETF BCP 47, "Tags for Identifying Languages"). |
| 578 | "displayName": "A String", # Localized display name. |
| 579 | "overview": "A String", # Localized brief description that the company uses to advertise themselves. |
| 580 | }, |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 581 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 582 | "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, |
| 583 | # converted to the requested currency code. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 584 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 585 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 586 | # If `units` is positive, `nanos` must be positive or zero. |
| 587 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 588 | # If `units` is negative, `nanos` must be negative or zero. |
| 589 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 590 | "units": "A String", # The whole units of the amount. |
| 591 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 592 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 593 | }, |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 594 | "primaryLanguageCode": "A String", # The primary language code of the company, as defined by |
| 595 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 596 | # (IETF BCP 47, "Tags for Identifying Languages"). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 597 | "name": "A String", # The name of the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 598 | }</pre> |
| 599 | </div> |
| 600 | |
| 601 | <div class="method"> |
| 602 | <code class="details" id="updateLeads">updateLeads(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</code> |
| 603 | <pre>Updates the specified lead. |
| 604 | |
| 605 | Args: |
| 606 | body: object, The request body. (required) |
| 607 | The object takes the form of: |
| 608 | |
| 609 | { # A lead resource that represents an advertiser contact for a `Company`. These |
| 610 | # are usually generated via Google Partner Search (the advertiser portal). |
| 611 | "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails |
| 612 | "languageCode": "A String", # Language code of the lead's language preference, as defined by |
| 613 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 614 | # (IETF BCP 47, "Tags for Identifying Languages"). |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 615 | "type": "A String", # Type of lead. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 616 | "familyName": "A String", # Last name of lead source. |
| 617 | "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 618 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 619 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 620 | # If `units` is positive, `nanos` must be positive or zero. |
| 621 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 622 | # If `units` is negative, `nanos` must be negative or zero. |
| 623 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 624 | "units": "A String", # The whole units of the amount. |
| 625 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 626 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 627 | }, |
| 628 | "comments": "A String", # Comments lead source gave. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 629 | "createTime": "A String", # Timestamp of when this lead was created. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 630 | "websiteUrl": "A String", # Website URL of lead source. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 631 | "email": "A String", # Email address of lead source. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 632 | "state": "A String", # The lead's state in relation to the company. |
| 633 | "phoneNumber": "A String", # Phone number of lead source. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 634 | "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. |
| 635 | "A String", |
| 636 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 637 | "givenName": "A String", # First name of lead source. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 638 | "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 639 | "id": "A String", # ID of the lead. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 640 | } |
| 641 | |
| 642 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 643 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 644 | An identifier has multiple letters created by a team which redirected the |
| 645 | traffic to us. |
| 646 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 647 | x__xgafv: string, V1 error format. |
| 648 | Allowed values |
| 649 | 1 - v1 error format |
| 650 | 2 - v2 error format |
| 651 | requestMetadata_locale: string, Locale to use for the current request. |
| 652 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 653 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 654 | An identifier has multiple letters created by a team which redirected the |
| 655 | traffic to us. |
| 656 | updateMask: string, Standard field mask for the set of fields to be updated. |
| 657 | Required with at least 1 value in FieldMask's paths. |
| 658 | Only `state` and `adwords_customer_id` are currently supported. |
| 659 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 660 | |
| 661 | Returns: |
| 662 | An object of the form: |
| 663 | |
| 664 | { # A lead resource that represents an advertiser contact for a `Company`. These |
| 665 | # are usually generated via Google Partner Search (the advertiser portal). |
| 666 | "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails |
| 667 | "languageCode": "A String", # Language code of the lead's language preference, as defined by |
| 668 | # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> |
| 669 | # (IETF BCP 47, "Tags for Identifying Languages"). |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 670 | "type": "A String", # Type of lead. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 671 | "familyName": "A String", # Last name of lead source. |
| 672 | "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 673 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 674 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 675 | # If `units` is positive, `nanos` must be positive or zero. |
| 676 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 677 | # If `units` is negative, `nanos` must be negative or zero. |
| 678 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 679 | "units": "A String", # The whole units of the amount. |
| 680 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 681 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 682 | }, |
| 683 | "comments": "A String", # Comments lead source gave. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 684 | "createTime": "A String", # Timestamp of when this lead was created. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 685 | "websiteUrl": "A String", # Website URL of lead source. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 686 | "email": "A String", # Email address of lead source. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 687 | "state": "A String", # The lead's state in relation to the company. |
| 688 | "phoneNumber": "A String", # Phone number of lead source. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 689 | "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. |
| 690 | "A String", |
| 691 | ], |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 692 | "givenName": "A String", # First name of lead source. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 693 | "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 694 | "id": "A String", # ID of the lead. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 695 | }</pre> |
| 696 | </div> |
| 697 | |
| 698 | </body></html> |