google-apis-webcontentpublisher_v1 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/webcontentpublisher_v1/classes.rb +79 -0
- data/lib/google/apis/webcontentpublisher_v1/gem_version.rb +2 -2
- data/lib/google/apis/webcontentpublisher_v1/representations.rb +43 -0
- data/lib/google/apis/webcontentpublisher_v1/service.rb +72 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c151515d750ba82d1e93c1b190ed31126dce709e053a39680ac0ff6726b3b72d
|
|
4
|
+
data.tar.gz: 48a25f9995b9c6df2b346bd4bc46d508e790e45f2cc74ae7f37f1098e84cd419
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8dab2e456fc1511093eeb92917e14999d57d41fd64cb0663cada89c3a22b26287ce59c6fbbc5f8a614e6040929fcc6dbd331c0ac1da7796e67f5813d4f3d3caa
|
|
7
|
+
data.tar.gz: 3956013748088fcfc3bc8ee331cbc514b2a98fad6f3c93d1b22fd71d280b5c196a049c3a8ce09a7ff899cd901d0e1fd850caee93b1851e94a565e47efd87a9d1
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Release history for google-apis-webcontentpublisher_v1
|
|
2
2
|
|
|
3
|
+
### v0.5.0 (2026-08-16)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20260812
|
|
6
|
+
|
|
7
|
+
### v0.4.0 (2026-07-26)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20260724
|
|
10
|
+
|
|
3
11
|
### v0.3.0 (2026-07-05)
|
|
4
12
|
|
|
5
13
|
* Regenerated from discovery document revision 20260629
|
|
@@ -139,6 +139,38 @@ module Google
|
|
|
139
139
|
end
|
|
140
140
|
end
|
|
141
141
|
|
|
142
|
+
# Request message for `GeneratePlatformSiteTokens`.
|
|
143
|
+
class GeneratePlatformSiteTokensRequest
|
|
144
|
+
include Google::Apis::Core::Hashable
|
|
145
|
+
|
|
146
|
+
def initialize(**args)
|
|
147
|
+
update!(**args)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# Update properties of this object
|
|
151
|
+
def update!(**args)
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Response message for `GeneratePlatformSiteTokens`.
|
|
156
|
+
class GeneratePlatformSiteTokensResponse
|
|
157
|
+
include Google::Apis::Core::Hashable
|
|
158
|
+
|
|
159
|
+
# List of domain-scoped secure token mappings.
|
|
160
|
+
# Corresponds to the JSON property `siteTokens`
|
|
161
|
+
# @return [Array<Google::Apis::WebcontentpublisherV1::SiteToken>]
|
|
162
|
+
attr_accessor :site_tokens
|
|
163
|
+
|
|
164
|
+
def initialize(**args)
|
|
165
|
+
update!(**args)
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Update properties of this object
|
|
169
|
+
def update!(**args)
|
|
170
|
+
@site_tokens = args[:site_tokens] if args.key?(:site_tokens)
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
|
|
142
174
|
# Response message for `ListCtas`.
|
|
143
175
|
class ListCtasResponse
|
|
144
176
|
include Google::Apis::Core::Hashable
|
|
@@ -211,6 +243,12 @@ module Google
|
|
|
211
243
|
attr_accessor :name_required
|
|
212
244
|
alias_method :name_required?, :name_required
|
|
213
245
|
|
|
246
|
+
# Optional. Whether checking the opt-in checkbox is required.
|
|
247
|
+
# Corresponds to the JSON property `optInRequired`
|
|
248
|
+
# @return [Boolean]
|
|
249
|
+
attr_accessor :opt_in_required
|
|
250
|
+
alias_method :opt_in_required?, :opt_in_required
|
|
251
|
+
|
|
214
252
|
# Required. The title of the newsletter signup prompt.
|
|
215
253
|
# Corresponds to the JSON property `title`
|
|
216
254
|
# @return [String]
|
|
@@ -225,6 +263,7 @@ module Google
|
|
|
225
263
|
@custom_consent_text = args[:custom_consent_text] if args.key?(:custom_consent_text)
|
|
226
264
|
@custom_message = args[:custom_message] if args.key?(:custom_message)
|
|
227
265
|
@name_required = args[:name_required] if args.key?(:name_required)
|
|
266
|
+
@opt_in_required = args[:opt_in_required] if args.key?(:opt_in_required)
|
|
228
267
|
@title = args[:title] if args.key?(:title)
|
|
229
268
|
end
|
|
230
269
|
end
|
|
@@ -301,6 +340,12 @@ module Google
|
|
|
301
340
|
# @return [String]
|
|
302
341
|
attr_accessor :publication_tos_url
|
|
303
342
|
|
|
343
|
+
# Optional. The publication entity type (for-profit vs non-profit). Defaults to
|
|
344
|
+
# FOR_PROFIT if omitted.
|
|
345
|
+
# Corresponds to the JSON property `publicationType`
|
|
346
|
+
# @return [String]
|
|
347
|
+
attr_accessor :publication_type
|
|
348
|
+
|
|
304
349
|
# Required. The ISO 3166-1 alpha-2 region code where the publication is
|
|
305
350
|
# registered (e.g., "US").
|
|
306
351
|
# Corresponds to the JSON property `regionCode`
|
|
@@ -337,6 +382,7 @@ module Google
|
|
|
337
382
|
@publication_id = args[:publication_id] if args.key?(:publication_id)
|
|
338
383
|
@publication_privacy_policy_url = args[:publication_privacy_policy_url] if args.key?(:publication_privacy_policy_url)
|
|
339
384
|
@publication_tos_url = args[:publication_tos_url] if args.key?(:publication_tos_url)
|
|
385
|
+
@publication_type = args[:publication_type] if args.key?(:publication_type)
|
|
340
386
|
@region_code = args[:region_code] if args.key?(:region_code)
|
|
341
387
|
@rrm_product = args[:rrm_product] if args.key?(:rrm_product)
|
|
342
388
|
@sl_product = args[:sl_product] if args.key?(:sl_product)
|
|
@@ -376,6 +422,31 @@ module Google
|
|
|
376
422
|
end
|
|
377
423
|
end
|
|
378
424
|
|
|
425
|
+
# Represents a domain-scoped secure token mapping.
|
|
426
|
+
class SiteToken
|
|
427
|
+
include Google::Apis::Core::Hashable
|
|
428
|
+
|
|
429
|
+
# The domain scope this token is valid for.
|
|
430
|
+
# Corresponds to the JSON property `domain`
|
|
431
|
+
# @return [String]
|
|
432
|
+
attr_accessor :domain
|
|
433
|
+
|
|
434
|
+
# The domain-scoped secure token value (ESUT).
|
|
435
|
+
# Corresponds to the JSON property `token`
|
|
436
|
+
# @return [String]
|
|
437
|
+
attr_accessor :token
|
|
438
|
+
|
|
439
|
+
def initialize(**args)
|
|
440
|
+
update!(**args)
|
|
441
|
+
end
|
|
442
|
+
|
|
443
|
+
# Update properties of this object
|
|
444
|
+
def update!(**args)
|
|
445
|
+
@domain = args[:domain] if args.key?(:domain)
|
|
446
|
+
@token = args[:token] if args.key?(:token)
|
|
447
|
+
end
|
|
448
|
+
end
|
|
449
|
+
|
|
379
450
|
# Subscription Linking (SL) product settings and status.
|
|
380
451
|
class SlProduct
|
|
381
452
|
include Google::Apis::Core::Hashable
|
|
@@ -406,6 +477,13 @@ module Google
|
|
|
406
477
|
class TosAcceptance
|
|
407
478
|
include Google::Apis::Core::Hashable
|
|
408
479
|
|
|
480
|
+
# Optional. Whether the user opted in to receive product updates and email
|
|
481
|
+
# communications.
|
|
482
|
+
# Corresponds to the JSON property `emailOptIn`
|
|
483
|
+
# @return [Boolean]
|
|
484
|
+
attr_accessor :email_opt_in
|
|
485
|
+
alias_method :email_opt_in?, :email_opt_in
|
|
486
|
+
|
|
409
487
|
# Optional. The name of the person who accepted the TOS.
|
|
410
488
|
# Corresponds to the JSON property `signer`
|
|
411
489
|
# @return [String]
|
|
@@ -428,6 +506,7 @@ module Google
|
|
|
428
506
|
|
|
429
507
|
# Update properties of this object
|
|
430
508
|
def update!(**args)
|
|
509
|
+
@email_opt_in = args[:email_opt_in] if args.key?(:email_opt_in)
|
|
431
510
|
@signer = args[:signer] if args.key?(:signer)
|
|
432
511
|
@signer_title = args[:signer_title] if args.key?(:signer_title)
|
|
433
512
|
@user_accepted = args[:user_accepted] if args.key?(:user_accepted)
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module WebcontentpublisherV1
|
|
18
18
|
# Version of the google-apis-webcontentpublisher_v1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.5.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.19.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20260812"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -46,6 +46,18 @@ module Google
|
|
|
46
46
|
include Google::Apis::Core::JsonObjectSupport
|
|
47
47
|
end
|
|
48
48
|
|
|
49
|
+
class GeneratePlatformSiteTokensRequest
|
|
50
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
51
|
+
|
|
52
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
class GeneratePlatformSiteTokensResponse
|
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
57
|
+
|
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
59
|
+
end
|
|
60
|
+
|
|
49
61
|
class ListCtasResponse
|
|
50
62
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
51
63
|
|
|
@@ -76,6 +88,12 @@ module Google
|
|
|
76
88
|
include Google::Apis::Core::JsonObjectSupport
|
|
77
89
|
end
|
|
78
90
|
|
|
91
|
+
class SiteToken
|
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
93
|
+
|
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
95
|
+
end
|
|
96
|
+
|
|
79
97
|
class SlProduct
|
|
80
98
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
81
99
|
|
|
@@ -123,6 +141,20 @@ module Google
|
|
|
123
141
|
end
|
|
124
142
|
end
|
|
125
143
|
|
|
144
|
+
class GeneratePlatformSiteTokensRequest
|
|
145
|
+
# @private
|
|
146
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
147
|
+
end
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
class GeneratePlatformSiteTokensResponse
|
|
151
|
+
# @private
|
|
152
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
153
|
+
collection :site_tokens, as: 'siteTokens', class: Google::Apis::WebcontentpublisherV1::SiteToken, decorator: Google::Apis::WebcontentpublisherV1::SiteToken::Representation
|
|
154
|
+
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
|
|
126
158
|
class ListCtasResponse
|
|
127
159
|
# @private
|
|
128
160
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -147,6 +179,7 @@ module Google
|
|
|
147
179
|
property :custom_consent_text, as: 'customConsentText'
|
|
148
180
|
property :custom_message, as: 'customMessage'
|
|
149
181
|
property :name_required, as: 'nameRequired'
|
|
182
|
+
property :opt_in_required, as: 'optInRequired'
|
|
150
183
|
property :title, as: 'title'
|
|
151
184
|
end
|
|
152
185
|
end
|
|
@@ -170,6 +203,7 @@ module Google
|
|
|
170
203
|
property :publication_id, as: 'publicationId'
|
|
171
204
|
property :publication_privacy_policy_url, as: 'publicationPrivacyPolicyUrl'
|
|
172
205
|
property :publication_tos_url, as: 'publicationTosUrl'
|
|
206
|
+
property :publication_type, as: 'publicationType'
|
|
173
207
|
property :region_code, as: 'regionCode'
|
|
174
208
|
property :rrm_product, as: 'rrmProduct', class: Google::Apis::WebcontentpublisherV1::RrmProduct, decorator: Google::Apis::WebcontentpublisherV1::RrmProduct::Representation
|
|
175
209
|
|
|
@@ -188,6 +222,14 @@ module Google
|
|
|
188
222
|
end
|
|
189
223
|
end
|
|
190
224
|
|
|
225
|
+
class SiteToken
|
|
226
|
+
# @private
|
|
227
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
228
|
+
property :domain, as: 'domain'
|
|
229
|
+
property :token, as: 'token'
|
|
230
|
+
end
|
|
231
|
+
end
|
|
232
|
+
|
|
191
233
|
class SlProduct
|
|
192
234
|
# @private
|
|
193
235
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -199,6 +241,7 @@ module Google
|
|
|
199
241
|
class TosAcceptance
|
|
200
242
|
# @private
|
|
201
243
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
244
|
+
property :email_opt_in, as: 'emailOptIn'
|
|
202
245
|
property :signer, as: 'signer'
|
|
203
246
|
property :signer_title, as: 'signerTitle'
|
|
204
247
|
property :user_accepted, as: 'userAccepted'
|
|
@@ -308,6 +308,43 @@ module Google
|
|
|
308
308
|
execute_or_queue_command(command, &block)
|
|
309
309
|
end
|
|
310
310
|
|
|
311
|
+
# Updates a CTA.
|
|
312
|
+
# @param [String] name
|
|
313
|
+
# Identifier. The resource name of the Cta. Format: organizations/`organization`/
|
|
314
|
+
# publications/`publication`/ctas/`cta`
|
|
315
|
+
# @param [Google::Apis::WebcontentpublisherV1::Cta] cta_object
|
|
316
|
+
# @param [String] update_mask
|
|
317
|
+
# Optional. The list of fields to update.
|
|
318
|
+
# @param [String] fields
|
|
319
|
+
# Selector specifying which fields to include in a partial response.
|
|
320
|
+
# @param [String] quota_user
|
|
321
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
322
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
323
|
+
# @param [Google::Apis::RequestOptions] options
|
|
324
|
+
# Request-specific options
|
|
325
|
+
#
|
|
326
|
+
# @yield [result, err] Result & error if block supplied
|
|
327
|
+
# @yieldparam result [Google::Apis::WebcontentpublisherV1::Cta] parsed result object
|
|
328
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
329
|
+
#
|
|
330
|
+
# @return [Google::Apis::WebcontentpublisherV1::Cta]
|
|
331
|
+
#
|
|
332
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
333
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
334
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
335
|
+
def patch_organization_publication_cta(name, cta_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
336
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
337
|
+
command.request_representation = Google::Apis::WebcontentpublisherV1::Cta::Representation
|
|
338
|
+
command.request_object = cta_object
|
|
339
|
+
command.response_representation = Google::Apis::WebcontentpublisherV1::Cta::Representation
|
|
340
|
+
command.response_class = Google::Apis::WebcontentpublisherV1::Cta
|
|
341
|
+
command.params['name'] = name unless name.nil?
|
|
342
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
343
|
+
command.query['fields'] = fields unless fields.nil?
|
|
344
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
345
|
+
execute_or_queue_command(command, &block)
|
|
346
|
+
end
|
|
347
|
+
|
|
311
348
|
# Checks if a user is eligible for free article access.
|
|
312
349
|
# @param [String] name
|
|
313
350
|
# Required. The resource name of the publication. Format: publications/`
|
|
@@ -344,6 +381,41 @@ module Google
|
|
|
344
381
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
345
382
|
execute_or_queue_command(command, &block)
|
|
346
383
|
end
|
|
384
|
+
|
|
385
|
+
# Returns user tokens mapped to their canonical domains for all publications the
|
|
386
|
+
# authenticated user is entitled to.
|
|
387
|
+
# @param [String] name
|
|
388
|
+
# Required. The resource name of the user to generate tokens for. Format: users/`
|
|
389
|
+
# user`
|
|
390
|
+
# @param [Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensRequest] generate_platform_site_tokens_request_object
|
|
391
|
+
# @param [String] fields
|
|
392
|
+
# Selector specifying which fields to include in a partial response.
|
|
393
|
+
# @param [String] quota_user
|
|
394
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
395
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
396
|
+
# @param [Google::Apis::RequestOptions] options
|
|
397
|
+
# Request-specific options
|
|
398
|
+
#
|
|
399
|
+
# @yield [result, err] Result & error if block supplied
|
|
400
|
+
# @yieldparam result [Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensResponse] parsed result object
|
|
401
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
402
|
+
#
|
|
403
|
+
# @return [Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensResponse]
|
|
404
|
+
#
|
|
405
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
406
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
407
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
408
|
+
def generate_user_platform_site_tokens(name, generate_platform_site_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
409
|
+
command = make_simple_command(:post, 'v1/{+name}:generatePlatformSiteTokens', options)
|
|
410
|
+
command.request_representation = Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensRequest::Representation
|
|
411
|
+
command.request_object = generate_platform_site_tokens_request_object
|
|
412
|
+
command.response_representation = Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensResponse::Representation
|
|
413
|
+
command.response_class = Google::Apis::WebcontentpublisherV1::GeneratePlatformSiteTokensResponse
|
|
414
|
+
command.params['name'] = name unless name.nil?
|
|
415
|
+
command.query['fields'] = fields unless fields.nil?
|
|
416
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
417
|
+
execute_or_queue_command(command, &block)
|
|
418
|
+
end
|
|
347
419
|
|
|
348
420
|
protected
|
|
349
421
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-webcontentpublisher_v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.5.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -57,7 +57,7 @@ licenses:
|
|
|
57
57
|
metadata:
|
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-webcontentpublisher_v1/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-webcontentpublisher_v1/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-webcontentpublisher_v1/v0.5.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-webcontentpublisher_v1
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|