Class EmbedClientItem

Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like Message in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details.

Inheritance

object

EmbedClientItem

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudSearch.v1.Data

Assembly: Google.Apis.CloudSearch.v1.dll

Syntax

public class EmbedClientItem : IDirectResponseSchema

Properties

CanonicalId

The canonical ID of the embed. If absent, the canonical ID is equal to the ID; if present, then the canonical ID represents an "equivalence class" of embeds which really refer to the same object. (For example, the URLs http://www.foo.com/ and http://foo.com/ refer to the same object) This field may be updated periodically by background processes.

Declaration

[JsonProperty("canonicalId")]
public virtual string CanonicalId { get; set; }

Property Value

Type	Description
string

DeepLinkData

Deep-linking data to take the user to the right place in a mobile app. This is only used for preview and attribution. Links that are specific to a given embed type should live on that specific embed's proto by using Link. See http://goto.google.com/mariana-design.

Declaration

[JsonProperty("deepLinkData")]
public virtual DeepLinkData DeepLinkData { get; set; }

Property Value

Type	Description
DeepLinkData

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Id

The ID of the embed. This corresponds to the schema.org ID, as represented in the ItemScope.id field.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

Provenance

The provenance of the embed, populated when the embed originated from a web fetch. The provenance captures information about the web page the embed had originated, like the URL that was retrieved and the retrieved URL's canonical form. This is useful in the case where the URL shared by the URL redirects (e.g., in the case of a shortened URL).

Declaration

[JsonProperty("provenance")]
public virtual Provenance Provenance { get; set; }

Property Value

Type	Description
Provenance

RenderId

The ID used to identify the embed during rendering. This field will match ID, if set, otherwise it will be the ID of the parent activity. This field is only populated on the server for client use and is not persisted to storage.

Declaration

[JsonProperty("renderId")]
public virtual string RenderId { get; set; }

Property Value

Type	Description
string

Signature

Signature of the embed, used for verification.

Declaration

[JsonProperty("signature")]
public virtual string Signature { get; set; }

Property Value

Type	Description
string

TransientData

Transient generic data that will not be saved on the server.

Declaration

[JsonProperty("transientData")]
public virtual TransientData TransientData { get; set; }

Property Value

Type	Description
TransientData

Type

The first value in type determines which extension field will be set. When creating an EmbedClientItem, you only need to set the first (primary) type in this field. When the server receives the item, it will populate the full type list using the parent annotations in the ItemType enum.

Declaration

[JsonProperty("type")]
public virtual IList<string> Type { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<T><string>

Implements

IDirectResponseSchema