Google Ads Ad Manager V1 Client - Class Content (0.8.0)

0.8.0 (latest) 0.7.0 0.6.2 0.5.0 0.4.1 0.3.1 0.2.0 0.1.3

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Content.

A piece of Content from a Publisher's CMS.

Generated from protobuf message google.ads.admanager.v1.Content

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The resource name of the Content. Format: networks/{network_code}/content/{content_id}
↳ display_name	string Output only. The name of the Content.
↳ status	int Output only. The status of this Content.
↳ content_status_source	int Output only. Whether the content status was defined by the user, or by the source CMS from which the Content was ingested.
↳ hls_ingest_status	int Output only. The current DAI ingest status of the HLS media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.
↳ hls_ingest_errors	array<DaiIngestError> Output only. The list of any errors that occurred during the most recent DAI ingestion process of the HLS media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.
↳ last_hls_ingest_time	Google\Protobuf\Timestamp Output only. The timestamp at which this Content's HLS media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.
↳ dash_ingest_status	int Output only. The current DAI ingest status of the DASH media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.
↳ dash_ingest_errors	array<DaiIngestError> Output only. The list of any errors that occurred during the most recent DAI ingestion process of the DASH media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.
↳ last_dash_ingest_time	Google\Protobuf\Timestamp Output only. The timestamp at which this Content's DASH media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.
↳ import_time	Google\Protobuf\Timestamp Output only. The timestamp at which this Content was published.
↳ update_time	Google\Protobuf\Timestamp Output only. The timestamp at which this Content was last modified. The last modified date time will always be updated when a ContentBundle association is changed, but will not always be updated when a CmsMetadataValue value is changed.
↳ cms_sources	array<CmsContent> Output only. Information about the Content from the CMS it was ingested from.
↳ content_bundles	string[] Output only. The resource names of the ContentBundles of which this Content is a member.
↳ cms_metadata_values	string[] Output only. The resource names of the [CmsMetadataValues] [google.ads.admanager.v1.CmsMetadataValue] that are associated with this Content.
↳ duration	Google\Protobuf\Duration Output only. The duration of the Content.

getName

Identifier. The resource name of the Content.

Format: networks/{network_code}/content/{content_id}

Returns
Type	Description
string

setName

Identifier. The resource name of the Content.

Format: networks/{network_code}/content/{content_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Output only. The name of the Content.

Returns
Type	Description
string

hasDisplayName

clearDisplayName

setDisplayName

Output only. The name of the Content.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStatus

Output only. The status of this Content.

Returns
Type	Description
int

hasStatus

clearStatus

setStatus

Output only. The status of this Content.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getContentStatusSource

Output only. Whether the content status was defined by the user, or by the source CMS from which the Content was ingested.

Returns
Type	Description
int

hasContentStatusSource

clearContentStatusSource

setContentStatusSource

Output only. Whether the content status was defined by the user, or by the source CMS from which the Content was ingested.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getHlsIngestStatus

Output only. The current DAI ingest status of the HLS media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Returns
Type	Description
int

hasHlsIngestStatus

clearHlsIngestStatus

setHlsIngestStatus

Output only. The current DAI ingest status of the HLS media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getHlsIngestErrors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the HLS media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Returns
Type	Description
Google\Protobuf\RepeatedField<DaiIngestError>

setHlsIngestErrors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the HLS media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Parameter
Name	Description
var	array<DaiIngestError>

Returns
Type	Description
$this

getLastHlsIngestTime

Output only. The timestamp at which this Content's HLS media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasLastHlsIngestTime

clearLastHlsIngestTime

setLastHlsIngestTime

Output only. The timestamp at which this Content's HLS media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDashIngestStatus

Output only. The current DAI ingest status of the DASH media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Returns
Type	Description
int

hasDashIngestStatus

clearDashIngestStatus

setDashIngestStatus

Output only. The current DAI ingest status of the DASH media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDashIngestErrors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the DASH media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Returns
Type	Description
Google\Protobuf\RepeatedField<DaiIngestError>

setDashIngestErrors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the DASH media. This attribute will be empty if the hlsIngestStatus is DaiIngestStatus.SUCCESS or if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Parameter
Name	Description
var	array<DaiIngestError>

Returns
Type	Description
$this

getLastDashIngestTime

Output only. The timestamp at which this Content's DASH media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasLastDashIngestTime

clearLastDashIngestTime

setLastDashIngestTime

Output only. The timestamp at which this Content's DASH media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getImportTime

Output only. The timestamp at which this Content was published.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasImportTime

clearImportTime

setImportTime

Output only. The timestamp at which this Content was published.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The timestamp at which this Content was last modified.

The last modified date time will always be updated when a ContentBundle association is changed, but will not always be updated when a CmsMetadataValue value is changed.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp at which this Content was last modified.

The last modified date time will always be updated when a ContentBundle association is changed, but will not always be updated when a CmsMetadataValue value is changed.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getCmsSources

Output only. Information about the Content from the CMS it was ingested from.

Returns
Type	Description
Google\Protobuf\RepeatedField<CmsContent>

setCmsSources

Output only. Information about the Content from the CMS it was ingested from.

Parameter
Name	Description
var	array<CmsContent>

Returns
Type	Description
$this

getContentBundles

Output only. The resource names of the ContentBundles of which this Content is a member.

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setContentBundles

Output only. The resource names of the ContentBundles of which this Content is a member.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getCmsMetadataValues

Output only. The resource names of the CmsMetadataValues that are associated with this Content.

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setCmsMetadataValues

Output only. The resource names of the CmsMetadataValues that are associated with this Content.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getDuration

Output only. The duration of the Content.

Returns
Type	Description
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

Output only. The duration of the Content.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this