Returns the ctas Resource.
Close httplib2 connections.
create(parent, body=None, publicationId=None, x__xgafv=None)
Creates a publication.
Gets a publication.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists publications.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a publication.
close()
Close httplib2 connections.
create(parent, body=None, publicationId=None, x__xgafv=None)
Creates a publication.
Args:
parent: string, Required. The parent resource where this publication will be created. Format: `organizations/{organization}`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
}
publicationId: string, Optional. The unique identifier of the publication to create. If not specified, the server will generate a random publication ID.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
}
get(name, x__xgafv=None)
Gets a publication.
Args:
name: string, Required. The resource name of the publication to retrieve. Format: `organizations/{organization}/publications/{publication}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists publications.
Args:
parent: string, Required. The parent organization whose publications to list. Format: `organizations/{organization}`. (required)
filter: string, Optional. A filter expression to filter the publications returned.
pageSize: integer, Optional. The maximum number of publications to return. The service may return fewer than this value. If unspecified, at most 50 publications will be returned.
pageToken: string, Optional. A page token, received from a previous `ListPublications` call, to retrieve the next page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `ListPublications`.
"nextPageToken": "A String", # Output only. A token to retrieve the next page of results, or empty if there are no more results.
"publications": [ # Output only. The list of publications.
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a publication.
Args:
name: string, Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a publisher's publication in Reader Revenue Manager.
"additionalDomains": [ # Optional. Additional domain properties verified for the publication.
{ # Represents a domain property associated with a publication, typically used to verify ownership and scope access.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
],
"contentPolicyStatus": { # The content policy status of the publication, indicating any violations. # Output only. The content policy compliance status of the publication.
"policyInfoUrl": "A String", # Output only. URL pointing to more details about the policy violation or status.
"state": "A String", # Output only. The current policy state.
},
"displayName": "A String", # Required. The user-visible display name of the publication.
"languageCode": "A String", # Required. The primary language of the publication (BCP-47 code, e.g., "en-US").
"name": "A String", # Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}
"onboardingState": "A String", # Output only. The current onboarding state.
"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication.
"paymentOption": "A String", # Output only. The configured payment option.
"primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication.
"ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).
"url": "A String", # Required. The URL of the domain property (e.g., "https://example.com").
},
"products": [ # Output only. The list of active products/features enabled for this publication.
"A String",
],
"publicationId": "A String", # Output only. The unique identifier of the publication.
"publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy.
"publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service.
"regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US").
"rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status.
"enabled": True or False, # Optional. Whether the RRM product is enabled for the publication.
"productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service.
"tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance.
"signer": "A String", # Optional. The name of the person who accepted the TOS.
"signerTitle": "A String", # Optional. The job title or role of the signer.
"userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service.
},
},
"slProduct": { # Subscription Linking (SL) product settings and status. # Optional. Subscription Linking product configurations.
"enabled": True or False, # Optional. Whether the Subscription Linking product is enabled.
"gcpProjectNumber": "A String", # Optional. The Google Cloud Project number associated with the publication.
},
}