Web Content Publisher API (webcontentpublisher:v1)

▼ ▲ webcontentpublisher.organizations.publications.create

Description : Creates a publication.

Parameters :

parent

Location : path

Required : Yes

Pattern : ^organizations/[^/]+$

Description : Required. The parent resource where this publication will be created. Format: `organizations/{organization}`.

Type : string

publicationId

Location : query

Description : Optional. The unique identifier of the publication to create. If not specified, the server will generate a random publication ID.

Type : string

Flat Path : v1/organizations/{organizationsId}/publications

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage

Path : v1/{+parent}/publications

HTTP Method : POST

▼ ▲ webcontentpublisher.organizations.publications.get

Parameters :

name

Pattern : ^organizations/[^/]+/publications/[^/]+$

Description : Required. The resource name of the publication to retrieve. Format: `organizations/{organization}/publications/{publication}`.

Type : string

Location : path

Required : Yes

Description : Gets a publication.

Flat Path : v1/organizations/{organizationsId}/publications/{publicationsId}

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage
• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly

Path : v1/{+name}

HTTP Method : GET

▼ ▲ webcontentpublisher.organizations.publications.patch

Parameter Order : name

Scopes : https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage

Flat Path : v1/organizations/{organizationsId}/publications/{publicationsId}

Path : v1/{+name}

HTTP Method : PATCH

Parameters :

updateMask

Location : query

Type : string

Format : google-fieldmask

Description : Optional. The list of fields to update.

name

Required : Yes

Location : path

Description : Identifier. The resource name of the publication. Format: organizations/{organization}/publications/{publication}

Type : string

Pattern : ^organizations/[^/]+/publications/[^/]+$

Description : Updates a publication.

▼ ▲ webcontentpublisher.organizations.publications.list

Description : Lists publications.

Parameters :

parent

Location : path

Required : Yes

Pattern : ^organizations/[^/]+$

Description : Required. The parent organization whose publications to list. Format: `organizations/{organization}`.

Type : string

pageSize

Type : integer

Format : int32

Description : 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.

Location : query

pageToken

Type : string

Description : Optional. A page token, received from a previous `ListPublications` call, to retrieve the next page.

Location : query

filter

Description : Optional. A filter expression to filter the publications returned.

Type : string

Location : query

Path : v1/{+parent}/publications

HTTP Method : GET

Flat Path : v1/organizations/{organizationsId}/publications

Parameter Order : parent

Scopes :

• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage
• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly

▼ ▲ webcontentpublisher.organizations.publications.ctas.list

Parameters :

parent

Location : path

Required : Yes

Pattern : ^organizations/[^/]+/publications/[^/]+$

Type : string

Description : Required. The parent publication resource whose CTAs to list. Format: `organizations/{organization}/publications/{publication}`.

pageSize

Description : Optional. The maximum number of CTAs to return. The service may return fewer than this value. If unspecified, at most 50 CTAs will be returned.

Type : integer

Format : int32

Location : query

pageToken

Location : query

Description : Optional. A page token, received from a previous `ListCtas` call, to retrieve the next page.

Type : string

Description : Lists CTAs.

Path : v1/{+parent}/ctas

HTTP Method : GET

Flat Path : v1/organizations/{organizationsId}/publications/{publicationsId}/ctas

Parameter Order : parent

Scopes :

• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage
• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly

▼ ▲ webcontentpublisher.organizations.publications.ctas.get

Description : Gets a CTA.

Parameters :

name

Required : Yes

Location : path

Description : Required. The resource name of the CTA to retrieve. Format: `organizations/{organization}/publications/{publication}/ctas/{cta}`.

Type : string

Pattern : ^organizations/[^/]+/publications/[^/]+/ctas/[^/]+$

Path : v1/{+name}

HTTP Method : GET

Flat Path : v1/organizations/{organizationsId}/publications/{publicationsId}/ctas/{ctasId}

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage
• https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly

▼ ▲ webcontentpublisher.organizations.publications.ctas.create

Path : v1/{+parent}/ctas

HTTP Method : POST

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage

Flat Path : v1/organizations/{organizationsId}/publications/{publicationsId}/ctas

Parameters :

parent

Description : Required. The parent publication resource where this CTA will be created. Format: `organizations/{organization}/publications/{publication}`.

Type : string

Pattern : ^organizations/[^/]+/publications/[^/]+$

Required : Yes

Location : path

ctaId

Description : Optional. The unique identifier of the CTA to create. If not specified, the server will generate a random CTA ID.

Type : string

Location : query

Description : Creates a CTA.

▼ ▲ webcontentpublisher.publications.checkFreeAccess

Scopes : https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly  ⟶  https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage