This section provides the details of the common properties of Watch Actions.
Action markup properties
Property | Expected type | Description |
---|---|---|
@type |
Text | Required - Always set to WatchAction . |
target |
EntryPoint | Required - A target object that provides the mapping of deep links to various Google platforms. |
target.@type |
Text | Required - Always set to EntryPoint . |
target.urlTemplate |
URL | Required - A deep link that takes users to your app or platform and initiates playback of the content. |
target.inLanguage |
Text | Optional - Original language of the series in BCP 47 format. |
target.actionPlatform |
Text | Required - The platforms that are mapped to
urlTemplate . Media Actions support the following:
|
target.additionalProperty |
PropertyValue | Required if applicable - A list of property-value pairs to
represent additional properties of the deep link. This can include the
following:
|
actionAccessibilityRequirement |
ActionAccessSpecification | Required - An Action access specification object that describes the access requirement of the content. See Action Access Specification Properties. |
Action markup related pages
Check out the following pages for the topics related to these properties:
Action access specification properties
Property | Expected type | Description |
---|---|---|
actionAccessibilityRequirement.@type |
Text | Required - Always set to ActionAccessSpecification . |
actionAccessibilityRequirement.category |
Text | Required - An access requirement for the content. For more information, see Paywall type. If an entity represents a group of content, you need to set
|
actionAccessibilityRequirement.availabilityStarts |
Date | Required - Date after which the action is available, in
ISO
8601 format (including timezone).
|
actionAccessibilityRequirement.availabilityEnds |
Date | Required - Date after which the action is no longer available,
in ISO
8601 format (including timezone).
|
actionAccessibilityRequirement.eligibleRegion |
Country, City, State, GeoShape, or Text | Required - Regions where the content is available. Use the
special string EARTH if the content is available globally. |
actionAccessibilityRequirement.ineligibleRegion |
Country, City, State, or GeoShape | Required if applicable - Regions where the content is
restricted. You don’t need to provide this property if the content is
available everywhere within eligibleRegion . |
actionAccessibilityRequirement.requiresSubscription |
MediaSubscription | Required if applicable - The details of the subscription that users need in order to access the content. See Media subscription properties.
|
actionAccessibilityRequirement.expectsAcceptanceOf |
Offer | Required if the content requires a purchase - The details of the
offer associated with the content. Provide the price information for the
following cases:
|
Media subscription properties
Required if actionAccessibilityRequirement.category
is
subscription
or externalSubscription
.
Property | Expected type | Description |
---|---|---|
requiresSubscription.@type |
Text | Required - Always set to MediaSubscription |
requiresSubscription.@id |
URL | Required - The unique ID for the subscription. If the content is accessible via different subscriptions, each subscription must have a unique ID. |
requiresSubscription.name |
Text | Required - The name of the subscription. Notice the following:
|
requiresSubscription.sameAs |
URL | The page that describes the subscription. |
requiresSubscription.identifier |
Text | Required if category is subscription AND
commonTier is false
-
A unique string for this subscription that represents access to a group of content in your media catalog.
|
requiresSubscription.authenticator |
Organization | Required if category is
externalsubscription - A container that provides the
details of the external provider's authenticator. |
requiresSubscription.authenticator.@type |
Text | Required if category is
externalsubscription - Always set to
Organization . |
requiresSubscription.authenticator.name |
Text | Required if category is
externalsubscription - The name of the authentication
service. For TVE providers, set it to TVE |
requiresSubscription.commonTier |
Boolean | Required if applicable - This is required if category is set to subscription. Read more about commonTier in the common tier requirements documentation. |
Entitlement API Requirements
An entitlement API is
required if actionAccessibilityRequirement.category
is subscription
or
externalSubscription
and your subscription offering includes multiple
packages or tiers or has add-on support. Don't include this if your
subscription is one tiered and gives access to all content in your catalog.
- Company A has a single subscription offering that gives subscribed users access to all available content: Entitlement Identifier / API is not required
- Company B has a base subscription that provides access to some content and a premium subscription that provides access to premium content: Entitlement Identifier / API is required
- Company C has a base subscription that provides access to some content and add on packages that provides access to third party content: Entitlement Identifier / API is required
Media subscription related pages
Check out the following pages for the topics related to these properties:
Offer properties
Property | Expected type | Description |
---|---|---|
expectsAcceptanceOf.@type |
Text | Required - Always set to Offer . |
expectsAcceptanceOf.price |
Number | Required - The purchase price of content. |
expectsAcceptanceOf.priceCurrency |
Text | Required - The currency of the price in 3-letter ISO 4217 format. |
expectsAcceptanceOf.seller |
Organization | The organization that offers the purchase of content. |
expectsAcceptanceOf.seller.@type |
Text | Always set to Organization . |
expectsAcceptanceOf.seller.name |
Text | The name of the seller. |
expectsAcceptanceOf.seller.sameAs |
Text | The URL of a web page that identifies the seller; for example, the seller's homepage. |
Offer related page
Check out the following pages for the topics related to these properties:
Identifier properties
Property | Expected type | Description |
---|---|---|
@type |
Text | Required - Always set to PropertyValue . |
propertyID |
Text | Required - We support the following ID types:
|
value |
Text | Required - The value for the specified ID system. |
Content rating agencies
Use the values in this table for BroadcastService.contentRating
, Movie.contentRating
and TVSeries.contentRating
. The rating agency should be prepended to the rating value. Examples:
- A movie rated "R" in the US should have a
Movie.contentRating
value of "MPAA R". - A TV series rated "TV-MA" in the US should have a
TVSeries.contentRating
value of "TV_PG TV-MA".
Country | TV rating agency | Movie rating agency |
---|---|---|
Albania (AL) | Not available | Not available |
Angola (AO) | Not available | CCE |
Antigua and Barbuda (AG) | Not available | MPAA |
Argentina (AR) | INCAA | INCAA |
Armenia (AM) | Not available | MKRF/RUSSIA |
Aruba (AW) | Not available | Not available |
Australia (AU) | ACB TV | ACB Movies |
Austria (AT) | FSK | FSK |
Azerbaijan (AZ) | Not available | MKRF/RUSSIA |
Bahrain (BH) | Not available | MPAA |
Belarus (BY) | Not available | MKRF/RUSSIA |
Belgium (BE) | Not available | MPAA |
Belize (BZ) | Not available | Not available |
Benin (BJ) | Not available | CNC |
Bolivia (BO) | Not available | MPAA |
Bosnia and Herzegovina (BA) | Not available | MPAA |
Botswana (BW) | Not available | MPAA |
Brazil (BR) | CLASSIND | CLASSIND |
Burkina Faso (BF) | Not available | CNC |
Cambodia (KH) | Not available | Not available |
Canada (CA) | CA_TV | CHVRS |
Cape Verde (CV) | Not available | CCE |
Chile (CL) | Not available | MPAA |
Colombia (CO) | Not available | MPAA |
Costa Rica (CR) | Not available | MPAA |
Croatia (HR) | Not available | Not available |
Cyprus (CY) | Not available | GRFILM |
Czechia (CZ) | Not available | CZFILM |
Denmark (DK) | Not available | MCCYP |
Ecuador (EC) | Not available | MPAA |
Egypt (EG) | Not available | MPAA |
El Salvador (SV) | Not available | MPAA |
Estonia (EE) | Not available | EEFILM |
Fiji (FJ) | Not available | Not available |
Finland (FI) | Not available | MEKU |
France (FR) | CSA | CSA |
Gabon (GA) | Not available | CNC |
Germany (DE) | FSK | FSK |
Greece (GR) | ESR | GRFILM |
Guatemala (GT) | Not available | MPAA |
Haiti (HT) | Not available | Not available |
Honduras (HN) | Not available | MPAA |
Hong Kong (HK) | CA | FCO |
Hungary (HU) | Not available | MPAA |
Iceland (IS) | Not available | KIJKWIJZER |
India (IN) | CBFC | CBFC |
Indonesia (ID) | KPI | LSF |
Ireland (IE) | Not available | IFCO |
Italy (IT) | AGCOM | AGCOM |
Ivory Coast (CI) | Not available | CNC |
Jamaica (JM) | Not available | MPAA |
Japan (JP) | NA | EIRIN |
Jordan (JO) | Not available | MPAA |
Kazakhstan (KZ) | Not available | MRKF |
Korea (KR) | KMRB | KMRB |
Kuwait (KW) | Not available | MPAA |
Kyrgyzstan (KG) | Not available | MKRF/RUSSIA |
Laos (LA) | Not available | Not available |
Latvia (LV) | Not available | NKCLV |
Lebanon (LB) | Not available | MPAA |
Lithuania (LT) | Not available | Not available |
Luxembourg (LU) | Not available | KIJKWIJZER |
Macedonia (MK) | Not available | MPAA |
Malaysia (MY) | Not available | FCBM |
Mali (ML) | Not available | CNC |
Malta (MT) | Not available | MCCAA |
Mauritius (MU) | Not available | BBFC |
Mexico (MX) | RTC | RTC |
Moldova (MD) | Not available | Not available |
Namibia (NA) | Not available | Not available |
Nepal (NP) | Not available | MPAA |
Netherlands (NL) | KIJKWIJZER | KIJKWIJZER |
New Zealand (NZ) | BSA | OFLC |
Nicaragua (NI) | Not available | MPAA |
Niger (NE) | Not available | CNC |
Norway (NO) | Not available | MEDIETILSYNET |
Oman (OM) | Not available | MPAA |
Panama (PA) | Not available | MPAA |
Papua New Guinea (PG) | Not available | MPAA |
Paraguay (PY) | Not available | MPAA |
Peru (PE) | Not available | MPAA |
Philippines (PH) | MTRCB | MTRCB |
Poland (PL) | Not available | MPAA |
Portugal (PT) | Not available | CCE |
Qatar (QA) | Not available | MPAA |
Russia (RU) | MKRF/RUSSIA | MKRF/RUSSIA |
Rwanda (RW) | Not available | CNC |
Saudi Arabia (SA) | Not available | MPAA |
Senegal (SN) | Not available | MPAA |
Singapore (SG) | Not available | MDA |
Slovakia (SK) | Not available | MPAA |
Slovenia (SI) | Not available | MPAA |
South Africa (ZA) | FPB | FPB |
Spain (ES) | SETSI | ICAA |
Sri Lanka (LK) | Not available | Not available |
Sweden (SE) | Not available | SMSA |
Switzerland (CH) | FSK | FSK |
Taiwan (TW) | Not available | MOCTW |
Tajikistan (TJ) | Not available | MKRF/RUSSIA |
Tanzania (TZ) | Not available | MPAA |
Thailand (TH) | Not available | BFVC |
Togo (TG) | Not available | CNC |
Trinidad and Tobago (TT) | Not available | Not available |
Turkey (TR) | RTÜK | ECBMCT |
Turkmenistan (TM) | Not available | MKRF/RUSSIA |
Uganda (UG) | Not available | MPAA |
Ukraine (UA) | Not available | Not available |
United Arab Emirates (AE) | Not available | MPAA |
United Kingdom (GB) | BBFC | BBFC |
United States (US) | TV_PG | MPAA |
Uruguay (UY) | Not available | MPAA |
Uzbekistan (UZ) | Not available | MKRF/RUSSIA |
Venezuela (VE) | Not available | RESORTEVIOLENCIA |
Vietnam (VN) | Not available | MCST |
Zambia (ZM) | Not available | MPAA |
Zimbabwe (ZW) | Not available | MPAA |
GeoShape properties
A GeoShape object contains one of the following data types:
- A list of postal codes (for example, US, Canadian or other zip code(s))
- A list of Canadian forward sortation areas
- A Designated Market Area (DMA) ID - An identifier of a region in the United States where people receive the same television channels and programs.
Property | Expected type | Description |
---|---|---|
@id |
URL | Required - The geo region's identifier in URI format. |
@type |
Text | Required - Always set to GeoShape . |
addressCountry |
Text | Required - The two-letter ISO 3166-1 alpha-2 country code. |
postalCode |
Text | Optional - List of one or more postal codes and/or FSA (forward sortation area) codes. |
identifier |
PropertyValue | Optional - A Designated Market Area (DMA) ID, which is an identifier of a region in the United States where people receive the same television channels and programs. |
identifier.@type |
Text | Required - Always set to PropertyValue . |
identifier.propertyID |
Text | Required - Always set to DMA_ID . |
identifier.value |
Text | Required - The DMA code for the region. |
Example of GeoShape
object that contains a list of ZIP codes:
{
"@type": "GeoShape",
"@id": "http://example.com/area1",
"addressCountry": "US",
"postalCode": [
"94118",
"94119"
]
}
Example of GeoShape
object that contains a combination of FSA (forward sortation area) and postal codes:
{
"@type": "GeoShape",
"@id": "http://example.com/area2",
"addressCountry": "CA",
"postalCode": [
"1A1",
"K1A",
"K1AOB1"
]
}
Example of GeoShape
object that contains a DMA ID:
{
"@type": "GeoShape",
"@id": "http://example.com/area3",
"addressCountry": "US",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "DMA_ID",
"value": "501"
}
]
}