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.users.html">users</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 78 | <code><a href="#createCompanyRelation">createCompanyRelation(userId, 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, requestMetadata_partnersSessionId=None)</a></code></p> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 79 | <p class="firstline">Creates a user's company relation. Affiliates the user to a company.</p> |
| 80 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 81 | <code><a href="#deleteCompanyRelation">deleteCompanyRelation(userId, 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> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 82 | <p class="firstline">Deletes a user's company relation. Unaffiliaites the user from a company.</p> |
| 83 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 84 | <code><a href="#get">get(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 85 | <p class="firstline">Gets a user.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#updateProfile">updateProfile(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, requestMetadata_partnersSessionId=None)</a></code></p> |
| 88 | <p class="firstline">Updates a user's profile. A user can only update their own profile and</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 91 | <code class="details" id="createCompanyRelation">createCompanyRelation(userId, 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, requestMetadata_partnersSessionId=None)</code> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 92 | <pre>Creates a user's company relation. Affiliates the user to a company. |
| 93 | |
| 94 | Args: |
| 95 | userId: string, The ID of the user. Can be set to <code>me</code> to mean |
| 96 | the currently authenticated user. (required) |
| 97 | body: object, The request body. (required) |
| 98 | The object takes the form of: |
| 99 | |
| 100 | { # A CompanyRelation resource representing information about a user's |
| 101 | # affiliation and standing with a company in Partners. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 102 | "website": "A String", # The website URL for this company. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 103 | "primaryCountryCode": "A String", # The primary country code of the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 104 | "specializationStatus": [ # The list of Google Partners specialization statuses for the company. |
| 105 | { # Agency specialization status |
| 106 | "badgeSpecialization": "A String", # The specialization this status is for. |
| 107 | "badgeSpecializationState": "A String", # State of agency specialization. |
| 108 | }, |
| 109 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 110 | "companyId": "A String", # The ID of the company. There may be no id if this is a |
| 111 | # pending company.5 |
| 112 | "isPending": True or False, # The flag that indicates if the company is pending verification. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 113 | "primaryAddress": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company. |
| 114 | # detailed (multi-field) version of the address. |
| 115 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 116 | "addressLine": [ # The following address lines represent the most specific part of any |
| 117 | # address. |
| 118 | "A String", |
| 119 | ], |
| 120 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 121 | # neighborhoods or boroughs in other locations. |
| 122 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 123 | # classification code for sorting mail. |
| 124 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 125 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 126 | # specified otherwise, this must conform to the |
| 127 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 128 | # standard</a>. Values must be within normalized ranges. |
| 129 | # |
| 130 | # Example of normalization code in Python: |
| 131 | # |
| 132 | # def NormalizeLongitude(longitude): |
| 133 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 134 | # q, r = divmod(longitude, 360.0) |
| 135 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 136 | # return r - 360.0 |
| 137 | # return r |
| 138 | # |
| 139 | # def NormalizeLatLng(latitude, longitude): |
| 140 | # """Wraps decimal degrees latitude and longitude to |
| 141 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 142 | # r = latitude % 360.0 |
| 143 | # if r <= 90.0: |
| 144 | # return r, NormalizeLongitude(longitude) |
| 145 | # elif r >= 270.0: |
| 146 | # return r - 360, NormalizeLongitude(longitude) |
| 147 | # else: |
| 148 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 149 | # |
| 150 | # assert 180.0 == NormalizeLongitude(180.0) |
| 151 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 152 | # assert -179.0 == NormalizeLongitude(181.0) |
| 153 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 154 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 155 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 156 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 157 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 158 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 159 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 160 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 161 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 162 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
| 163 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 164 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 165 | }, |
| 166 | "locality": "A String", # Generally refers to the city/town portion of an address. |
| 167 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 168 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 169 | "address": "A String", # The single string version of the address. |
| 170 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 171 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 172 | "address": "A String", # The primary address for this company. |
| 173 | "creationTime": "A String", # The timestamp of when affiliation was requested. |
| 174 | # @OutputOnly |
| 175 | "companyAdmin": True or False, # Indicates if the user is an admin for this company. |
| 176 | "badgeTier": "A String", # Whether the company is a Partner. |
| 177 | "state": "A String", # The state of relationship, in terms of approvals. |
| 178 | "phoneNumber": "A String", # The phone number for the company's primary address. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 179 | "managerAccount": "A String", # The AdWords manager account # associated this company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 180 | "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 181 | "primaryLanguageCode": "A String", # The primary language code of the company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 182 | "resolvedTimestamp": "A String", # The timestamp when the user was approved. |
| 183 | # @OutputOnly |
| 184 | "segment": [ # The segment the company is classified as. |
| 185 | "A String", |
| 186 | ], |
| 187 | "name": "A String", # The name (in the company's primary language) for the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 191 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 192 | An identifier has multiple letters created by a team which redirected the |
| 193 | traffic to us. |
| 194 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
| 199 | requestMetadata_locale: string, Locale to use for the current request. |
| 200 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 201 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 202 | An identifier has multiple letters created by a team which redirected the |
| 203 | traffic to us. |
| 204 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 205 | |
| 206 | Returns: |
| 207 | An object of the form: |
| 208 | |
| 209 | { # A CompanyRelation resource representing information about a user's |
| 210 | # affiliation and standing with a company in Partners. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 211 | "website": "A String", # The website URL for this company. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 212 | "primaryCountryCode": "A String", # The primary country code of the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 213 | "specializationStatus": [ # The list of Google Partners specialization statuses for the company. |
| 214 | { # Agency specialization status |
| 215 | "badgeSpecialization": "A String", # The specialization this status is for. |
| 216 | "badgeSpecializationState": "A String", # State of agency specialization. |
| 217 | }, |
| 218 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 219 | "companyId": "A String", # The ID of the company. There may be no id if this is a |
| 220 | # pending company.5 |
| 221 | "isPending": True or False, # The flag that indicates if the company is pending verification. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 222 | "primaryAddress": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company. |
| 223 | # detailed (multi-field) version of the address. |
| 224 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 225 | "addressLine": [ # The following address lines represent the most specific part of any |
| 226 | # address. |
| 227 | "A String", |
| 228 | ], |
| 229 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 230 | # neighborhoods or boroughs in other locations. |
| 231 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 232 | # classification code for sorting mail. |
| 233 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 234 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 235 | # specified otherwise, this must conform to the |
| 236 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 237 | # standard</a>. Values must be within normalized ranges. |
| 238 | # |
| 239 | # Example of normalization code in Python: |
| 240 | # |
| 241 | # def NormalizeLongitude(longitude): |
| 242 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 243 | # q, r = divmod(longitude, 360.0) |
| 244 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 245 | # return r - 360.0 |
| 246 | # return r |
| 247 | # |
| 248 | # def NormalizeLatLng(latitude, longitude): |
| 249 | # """Wraps decimal degrees latitude and longitude to |
| 250 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 251 | # r = latitude % 360.0 |
| 252 | # if r <= 90.0: |
| 253 | # return r, NormalizeLongitude(longitude) |
| 254 | # elif r >= 270.0: |
| 255 | # return r - 360, NormalizeLongitude(longitude) |
| 256 | # else: |
| 257 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 258 | # |
| 259 | # assert 180.0 == NormalizeLongitude(180.0) |
| 260 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 261 | # assert -179.0 == NormalizeLongitude(181.0) |
| 262 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 263 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 264 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 265 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 266 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 267 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 268 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 269 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 270 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 271 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
| 272 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 273 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 274 | }, |
| 275 | "locality": "A String", # Generally refers to the city/town portion of an address. |
| 276 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 277 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 278 | "address": "A String", # The single string version of the address. |
| 279 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 280 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 281 | "address": "A String", # The primary address for this company. |
| 282 | "creationTime": "A String", # The timestamp of when affiliation was requested. |
| 283 | # @OutputOnly |
| 284 | "companyAdmin": True or False, # Indicates if the user is an admin for this company. |
| 285 | "badgeTier": "A String", # Whether the company is a Partner. |
| 286 | "state": "A String", # The state of relationship, in terms of approvals. |
| 287 | "phoneNumber": "A String", # The phone number for the company's primary address. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 288 | "managerAccount": "A String", # The AdWords manager account # associated this company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 289 | "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 290 | "primaryLanguageCode": "A String", # The primary language code of the company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 291 | "resolvedTimestamp": "A String", # The timestamp when the user was approved. |
| 292 | # @OutputOnly |
| 293 | "segment": [ # The segment the company is classified as. |
| 294 | "A String", |
| 295 | ], |
| 296 | "name": "A String", # The name (in the company's primary language) for the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 297 | }</pre> |
| 298 | </div> |
| 299 | |
| 300 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 301 | <code class="details" id="deleteCompanyRelation">deleteCompanyRelation(userId, 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> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 302 | <pre>Deletes a user's company relation. Unaffiliaites the user from a company. |
| 303 | |
| 304 | Args: |
| 305 | userId: string, The ID of the user. Can be set to <code>me</code> to mean |
| 306 | the currently authenticated user. (required) |
| 307 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 308 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 309 | An identifier has multiple letters created by a team which redirected the |
| 310 | traffic to us. |
| 311 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 312 | x__xgafv: string, V1 error format. |
| 313 | Allowed values |
| 314 | 1 - v1 error format |
| 315 | 2 - v2 error format |
| 316 | requestMetadata_locale: string, Locale to use for the current request. |
| 317 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 318 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 319 | An identifier has multiple letters created by a team which redirected the |
| 320 | traffic to us. |
| 321 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 322 | |
| 323 | Returns: |
| 324 | An object of the form: |
| 325 | |
| 326 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 327 | # empty messages in your APIs. A typical example is to use it as the request |
| 328 | # or the response type of an API method. For instance: |
| 329 | # |
| 330 | # service Foo { |
| 331 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 332 | # } |
| 333 | # |
| 334 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 335 | }</pre> |
| 336 | </div> |
| 337 | |
| 338 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 339 | <code class="details" id="get">get(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 340 | <pre>Gets a user. |
| 341 | |
| 342 | Args: |
| 343 | userId: string, Identifier of the user. Can be set to <code>me</code> to mean the currently |
| 344 | authenticated user. (required) |
| 345 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 346 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 347 | An identifier has multiple letters created by a team which redirected the |
| 348 | traffic to us. |
| 349 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 350 | x__xgafv: string, V1 error format. |
| 351 | Allowed values |
| 352 | 1 - v1 error format |
| 353 | 2 - v2 error format |
| 354 | requestMetadata_locale: string, Locale to use for the current request. |
| 355 | userView: string, Specifies what parts of the user information to return. |
| 356 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 357 | requestMetadata_trafficSource_trafficSourceId: string, 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_partnersSessionId: string, Google Partners session ID. |
| 361 | |
| 362 | Returns: |
| 363 | An object of the form: |
| 364 | |
| 365 | { # A resource representing a user of the Partners platform. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 366 | "profile": { # The profile information of a Partners user. # The profile information of a Partners user, contains all the directly |
| 367 | # editable user information. |
| 368 | "industries": [ # A list of ids representing which industries the user selected. |
| 369 | "A String", |
| 370 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 371 | "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 372 | "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the |
| 373 | # preferred account and it is used when a personal account is needed. Can |
| 374 | # be empty. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 375 | "languages": [ # The list of languages this user understands. |
| 376 | "A String", |
| 377 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 378 | "markets": [ # A list of ids representing which markets the user was interested in. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 379 | "A String", |
| 380 | ], |
| 381 | "emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences. |
| 382 | "specialOffers": True or False, # An opt-in about receiving email regarding new features and products. |
| 383 | "marketComm": True or False, # An opt-in about receiving email from Partners marketing teams. Includes |
| 384 | # member-only events and special promotional offers for Google products. |
| 385 | "phoneContact": True or False, # An opt-in to allow recieivng phone calls about their Partners account. |
| 386 | "physicalMail": True or False, # An opt-in to receive special promotional gifts and material in the mail. |
| 387 | "performanceSuggestions": True or False, # An opt-in about receiving email with customized AdWords campaign management |
| 388 | # tips. |
| 389 | }, |
| 390 | "familyName": "A String", # The user's family name. |
| 391 | "channels": [ # A list of ids representing which channels the user selected they were in. |
| 392 | "A String", |
| 393 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 394 | "emailAddress": "A String", # The email address the user has selected on the Partners site as primary. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 395 | "address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields. |
| 396 | # detailed (multi-field) version of the address. |
| 397 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 398 | "addressLine": [ # The following address lines represent the most specific part of any |
| 399 | # address. |
| 400 | "A String", |
| 401 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 402 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 403 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 404 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 405 | # classification code for sorting mail. |
| 406 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 407 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 408 | # specified otherwise, this must conform to the |
| 409 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 410 | # standard</a>. Values must be within normalized ranges. |
| 411 | # |
| 412 | # Example of normalization code in Python: |
| 413 | # |
| 414 | # def NormalizeLongitude(longitude): |
| 415 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 416 | # q, r = divmod(longitude, 360.0) |
| 417 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 418 | # return r - 360.0 |
| 419 | # return r |
| 420 | # |
| 421 | # def NormalizeLatLng(latitude, longitude): |
| 422 | # """Wraps decimal degrees latitude and longitude to |
| 423 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 424 | # r = latitude % 360.0 |
| 425 | # if r <= 90.0: |
| 426 | # return r, NormalizeLongitude(longitude) |
| 427 | # elif r >= 270.0: |
| 428 | # return r - 360, NormalizeLongitude(longitude) |
| 429 | # else: |
| 430 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 431 | # |
| 432 | # assert 180.0 == NormalizeLongitude(180.0) |
| 433 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 434 | # assert -179.0 == NormalizeLongitude(181.0) |
| 435 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 436 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 437 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 438 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 439 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 440 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 441 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 442 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 443 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 444 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 445 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 446 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 447 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 448 | "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] | 449 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 450 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 451 | "address": "A String", # The single string version of the address. |
| 452 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 453 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 454 | "phoneNumber": "A String", # The user's phone number. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 455 | "givenName": "A String", # The user's given name. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 456 | "jobFunctions": [ # A list of ids represnting which job categories the user selected. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 457 | "A String", |
| 458 | ], |
| 459 | "profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL. |
| 460 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 461 | "companyVerificationEmail": "A String", # The email address used by the user used for company verification. |
| 462 | # @OutputOnly |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 463 | "certificationStatus": [ # The list of achieved certifications. These are calculated based on exam |
| 464 | # results and other requirements. |
| 465 | # @OutputOnly |
| 466 | { # A user's information on a specific certification. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 467 | "lastAchieved": "A String", # The date the user last achieved certification. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 468 | "warning": True or False, # Whether this certification is in the state of warning. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 469 | "expiration": "A String", # Date this certification is due to expire. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 470 | "certificationType": "A String", # The type of certification, the area of expertise. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 471 | "achieved": True or False, # Whether this certification has been achieved. |
| 472 | }, |
| 473 | ], |
| 474 | "availableAdwordsManagerAccounts": [ # This is the list of AdWords Manager Accounts the user has edit access to. |
| 475 | # If the user has edit access to multiple accounts, the user can choose the |
| 476 | # preferred account and we use this when a personal account is needed. Can |
| 477 | # be empty meaning the user has access to no accounts. |
| 478 | # @OutputOnly |
| 479 | { # Information about a particular AdWords Manager Account. |
| 480 | # Read more at https://support.google.com/adwords/answer/6139186 |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 481 | "id": "A String", # The AdWords Manager Account id. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 482 | "customerName": "A String", # Name of the customer this account represents. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 483 | }, |
| 484 | ], |
| 485 | "company": { # A CompanyRelation resource representing information about a user's # The company that the user is associated with. |
| 486 | # If not present, the user is not associated with any company. |
| 487 | # affiliation and standing with a company in Partners. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 488 | "website": "A String", # The website URL for this company. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 489 | "primaryCountryCode": "A String", # The primary country code of the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 490 | "specializationStatus": [ # The list of Google Partners specialization statuses for the company. |
| 491 | { # Agency specialization status |
| 492 | "badgeSpecialization": "A String", # The specialization this status is for. |
| 493 | "badgeSpecializationState": "A String", # State of agency specialization. |
| 494 | }, |
| 495 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 496 | "companyId": "A String", # The ID of the company. There may be no id if this is a |
| 497 | # pending company.5 |
| 498 | "isPending": True or False, # The flag that indicates if the company is pending verification. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 499 | "primaryAddress": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company. |
| 500 | # detailed (multi-field) version of the address. |
| 501 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 502 | "addressLine": [ # The following address lines represent the most specific part of any |
| 503 | # address. |
| 504 | "A String", |
| 505 | ], |
| 506 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 507 | # neighborhoods or boroughs in other locations. |
| 508 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 509 | # classification code for sorting mail. |
| 510 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 511 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 512 | # specified otherwise, this must conform to the |
| 513 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 514 | # standard</a>. Values must be within normalized ranges. |
| 515 | # |
| 516 | # Example of normalization code in Python: |
| 517 | # |
| 518 | # def NormalizeLongitude(longitude): |
| 519 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 520 | # q, r = divmod(longitude, 360.0) |
| 521 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 522 | # return r - 360.0 |
| 523 | # return r |
| 524 | # |
| 525 | # def NormalizeLatLng(latitude, longitude): |
| 526 | # """Wraps decimal degrees latitude and longitude to |
| 527 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 528 | # r = latitude % 360.0 |
| 529 | # if r <= 90.0: |
| 530 | # return r, NormalizeLongitude(longitude) |
| 531 | # elif r >= 270.0: |
| 532 | # return r - 360, NormalizeLongitude(longitude) |
| 533 | # else: |
| 534 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 535 | # |
| 536 | # assert 180.0 == NormalizeLongitude(180.0) |
| 537 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 538 | # assert -179.0 == NormalizeLongitude(181.0) |
| 539 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 540 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 541 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 542 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 543 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 544 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 545 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 546 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 547 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 548 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
| 549 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 550 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 551 | }, |
| 552 | "locality": "A String", # Generally refers to the city/town portion of an address. |
| 553 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 554 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 555 | "address": "A String", # The single string version of the address. |
| 556 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 557 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 558 | "address": "A String", # The primary address for this company. |
| 559 | "creationTime": "A String", # The timestamp of when affiliation was requested. |
| 560 | # @OutputOnly |
| 561 | "companyAdmin": True or False, # Indicates if the user is an admin for this company. |
| 562 | "badgeTier": "A String", # Whether the company is a Partner. |
| 563 | "state": "A String", # The state of relationship, in terms of approvals. |
| 564 | "phoneNumber": "A String", # The phone number for the company's primary address. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 565 | "managerAccount": "A String", # The AdWords manager account # associated this company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 566 | "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 567 | "primaryLanguageCode": "A String", # The primary language code of the company. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 568 | "resolvedTimestamp": "A String", # The timestamp when the user was approved. |
| 569 | # @OutputOnly |
| 570 | "segment": [ # The segment the company is classified as. |
| 571 | "A String", |
| 572 | ], |
| 573 | "name": "A String", # The name (in the company's primary language) for the company. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 574 | }, |
| 575 | "lastAccessTime": "A String", # The most recent time the user interacted with the Partners site. |
| 576 | # @OutputOnly |
| 577 | "primaryEmails": [ # The list of emails the user has access to/can select as primary. |
| 578 | # @OutputOnly |
| 579 | "A String", |
| 580 | ], |
| 581 | "id": "A String", # The ID of the user. |
| 582 | "publicProfile": { # Basic information from a public profile. # Information about a user's external public profile outside Google Partners. |
| 583 | "url": "A String", # The URL of the public profile. |
| 584 | "profileImage": "A String", # The URL to the main profile image of the public profile. |
| 585 | "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated. |
| 586 | "displayName": "A String", # The display name of the public profile. |
| 587 | "id": "A String", # The ID which can be used to retrieve more details about the public profile. |
| 588 | }, |
| 589 | "examStatus": [ # The list of exams the user ever taken. For each type of exam, only one |
| 590 | # entry is listed. |
| 591 | { # A user's information on a specific exam. |
| 592 | "examType": "A String", # The type of the exam. |
| 593 | "warning": True or False, # Whether this exam is in the state of warning. |
| 594 | "expiration": "A String", # Date this exam is due to expire. |
| 595 | "passed": True or False, # Whether this exam has been passed and not expired. |
| 596 | "taken": "A String", # The date the user last taken this exam. |
| 597 | "lastPassed": "A String", # The date the user last passed this exam. |
| 598 | }, |
| 599 | ], |
| 600 | }</pre> |
| 601 | </div> |
| 602 | |
| 603 | <div class="method"> |
| 604 | <code class="details" id="updateProfile">updateProfile(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, requestMetadata_partnersSessionId=None)</code> |
| 605 | <pre>Updates a user's profile. A user can only update their own profile and |
| 606 | should only be called within the context of a logged in user. |
| 607 | |
| 608 | Args: |
| 609 | body: object, The request body. (required) |
| 610 | The object takes the form of: |
| 611 | |
| 612 | { # The profile information of a Partners user. |
| 613 | "industries": [ # A list of ids representing which industries the user selected. |
| 614 | "A String", |
| 615 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 616 | "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 617 | "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the |
| 618 | # preferred account and it is used when a personal account is needed. Can |
| 619 | # be empty. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 620 | "languages": [ # The list of languages this user understands. |
| 621 | "A String", |
| 622 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 623 | "markets": [ # A list of ids representing which markets the user was interested in. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 624 | "A String", |
| 625 | ], |
| 626 | "emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences. |
| 627 | "specialOffers": True or False, # An opt-in about receiving email regarding new features and products. |
| 628 | "marketComm": True or False, # An opt-in about receiving email from Partners marketing teams. Includes |
| 629 | # member-only events and special promotional offers for Google products. |
| 630 | "phoneContact": True or False, # An opt-in to allow recieivng phone calls about their Partners account. |
| 631 | "physicalMail": True or False, # An opt-in to receive special promotional gifts and material in the mail. |
| 632 | "performanceSuggestions": True or False, # An opt-in about receiving email with customized AdWords campaign management |
| 633 | # tips. |
| 634 | }, |
| 635 | "familyName": "A String", # The user's family name. |
| 636 | "channels": [ # A list of ids representing which channels the user selected they were in. |
| 637 | "A String", |
| 638 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 639 | "emailAddress": "A String", # The email address the user has selected on the Partners site as primary. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 640 | "address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields. |
| 641 | # detailed (multi-field) version of the address. |
| 642 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 643 | "addressLine": [ # The following address lines represent the most specific part of any |
| 644 | # address. |
| 645 | "A String", |
| 646 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 647 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 648 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 649 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 650 | # classification code for sorting mail. |
| 651 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 652 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 653 | # specified otherwise, this must conform to the |
| 654 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 655 | # standard</a>. Values must be within normalized ranges. |
| 656 | # |
| 657 | # Example of normalization code in Python: |
| 658 | # |
| 659 | # def NormalizeLongitude(longitude): |
| 660 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 661 | # q, r = divmod(longitude, 360.0) |
| 662 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 663 | # return r - 360.0 |
| 664 | # return r |
| 665 | # |
| 666 | # def NormalizeLatLng(latitude, longitude): |
| 667 | # """Wraps decimal degrees latitude and longitude to |
| 668 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 669 | # r = latitude % 360.0 |
| 670 | # if r <= 90.0: |
| 671 | # return r, NormalizeLongitude(longitude) |
| 672 | # elif r >= 270.0: |
| 673 | # return r - 360, NormalizeLongitude(longitude) |
| 674 | # else: |
| 675 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 676 | # |
| 677 | # assert 180.0 == NormalizeLongitude(180.0) |
| 678 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 679 | # assert -179.0 == NormalizeLongitude(181.0) |
| 680 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 681 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 682 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 683 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 684 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 685 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 686 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 687 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 688 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 689 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 690 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 691 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 692 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 693 | "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] | 694 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 695 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 696 | "address": "A String", # The single string version of the address. |
| 697 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 698 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 699 | "phoneNumber": "A String", # The user's phone number. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 700 | "givenName": "A String", # The user's given name. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 701 | "jobFunctions": [ # A list of ids represnting which job categories the user selected. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 702 | "A String", |
| 703 | ], |
| 704 | "profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL. |
| 705 | } |
| 706 | |
| 707 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 708 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 709 | An identifier has multiple letters created by a team which redirected the |
| 710 | traffic to us. |
| 711 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 712 | x__xgafv: string, V1 error format. |
| 713 | Allowed values |
| 714 | 1 - v1 error format |
| 715 | 2 - v2 error format |
| 716 | requestMetadata_locale: string, Locale to use for the current request. |
| 717 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 718 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 719 | An identifier has multiple letters created by a team which redirected the |
| 720 | traffic to us. |
| 721 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 722 | |
| 723 | Returns: |
| 724 | An object of the form: |
| 725 | |
| 726 | { # The profile information of a Partners user. |
| 727 | "industries": [ # A list of ids representing which industries the user selected. |
| 728 | "A String", |
| 729 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 730 | "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 731 | "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the |
| 732 | # preferred account and it is used when a personal account is needed. Can |
| 733 | # be empty. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 734 | "languages": [ # The list of languages this user understands. |
| 735 | "A String", |
| 736 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 737 | "markets": [ # A list of ids representing which markets the user was interested in. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 738 | "A String", |
| 739 | ], |
| 740 | "emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences. |
| 741 | "specialOffers": True or False, # An opt-in about receiving email regarding new features and products. |
| 742 | "marketComm": True or False, # An opt-in about receiving email from Partners marketing teams. Includes |
| 743 | # member-only events and special promotional offers for Google products. |
| 744 | "phoneContact": True or False, # An opt-in to allow recieivng phone calls about their Partners account. |
| 745 | "physicalMail": True or False, # An opt-in to receive special promotional gifts and material in the mail. |
| 746 | "performanceSuggestions": True or False, # An opt-in about receiving email with customized AdWords campaign management |
| 747 | # tips. |
| 748 | }, |
| 749 | "familyName": "A String", # The user's family name. |
| 750 | "channels": [ # A list of ids representing which channels the user selected they were in. |
| 751 | "A String", |
| 752 | ], |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 753 | "emailAddress": "A String", # The email address the user has selected on the Partners site as primary. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 754 | "address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields. |
| 755 | # detailed (multi-field) version of the address. |
| 756 | "languageCode": "A String", # Language code of the address. Should be in BCP 47 format. |
| 757 | "addressLine": [ # The following address lines represent the most specific part of any |
| 758 | # address. |
| 759 | "A String", |
| 760 | ], |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 761 | "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or |
| 762 | # neighborhoods or boroughs in other locations. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 763 | "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary |
| 764 | # classification code for sorting mail. |
| 765 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees. |
| 766 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 767 | # specified otherwise, this must conform to the |
| 768 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 769 | # standard</a>. Values must be within normalized ranges. |
| 770 | # |
| 771 | # Example of normalization code in Python: |
| 772 | # |
| 773 | # def NormalizeLongitude(longitude): |
| 774 | # """Wraps decimal degrees longitude to [-180.0, 180.0].""" |
| 775 | # q, r = divmod(longitude, 360.0) |
| 776 | # if r > 180.0 or (r == 180.0 and q <= -1.0): |
| 777 | # return r - 360.0 |
| 778 | # return r |
| 779 | # |
| 780 | # def NormalizeLatLng(latitude, longitude): |
| 781 | # """Wraps decimal degrees latitude and longitude to |
| 782 | # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" |
| 783 | # r = latitude % 360.0 |
| 784 | # if r <= 90.0: |
| 785 | # return r, NormalizeLongitude(longitude) |
| 786 | # elif r >= 270.0: |
| 787 | # return r - 360, NormalizeLongitude(longitude) |
| 788 | # else: |
| 789 | # return 180 - r, NormalizeLongitude(longitude + 180.0) |
| 790 | # |
| 791 | # assert 180.0 == NormalizeLongitude(180.0) |
| 792 | # assert -180.0 == NormalizeLongitude(-180.0) |
| 793 | # assert -179.0 == NormalizeLongitude(181.0) |
| 794 | # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) |
| 795 | # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) |
| 796 | # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) |
| 797 | # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) |
| 798 | # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) |
| 799 | # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) |
| 800 | # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) |
| 801 | # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) |
| 802 | # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) |
| 803 | # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 804 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 805 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 806 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 807 | "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] | 808 | "regionCode": "A String", # CLDR (Common Locale Data Repository) region code . |
| 809 | "administrativeArea": "A String", # Top-level administrative subdivision of this country. |
| 810 | "address": "A String", # The single string version of the address. |
| 811 | "postalCode": "A String", # Values are frequently alphanumeric. |
| 812 | }, |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 813 | "phoneNumber": "A String", # The user's phone number. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 814 | "givenName": "A String", # The user's given name. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 815 | "jobFunctions": [ # A list of ids represnting which job categories the user selected. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 816 | "A String", |
| 817 | ], |
| 818 | "profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL. |
| 819 | }</pre> |
| 820 | </div> |
| 821 | |
| 822 | </body></html> |