updatePrimaryVersion(name, body=None, x__xgafv=None)
-
Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key.
+ Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.
Args:
name: string, Required. The resource name of the CryptoKey to update. (required)
diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html
index 4f71a3fd441..96acf9cb890 100644
--- a/docs/dyn/datastore_v1.projects.html
+++ b/docs/dyn/datastore_v1.projects.html
@@ -248,7 +248,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
"update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path.
@@ -266,7 +299,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
"upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
@@ -284,7 +350,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
},
@@ -503,7 +602,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -527,7 +659,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -625,24 +790,7 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
- },
- },
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -681,24 +829,7 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
- },
- },
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -759,24 +890,7 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
- },
- },
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -863,7 +977,40 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
+ "a_key": { # A message that can hold any of the supported value types and associated metadata.
+ "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
+ # Object with schema name: Value
+ ],
+ },
+ "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
+ "booleanValue": True or False, # A boolean value.
+ "doubleValue": 3.14, # A double value.
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
+ "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "integerValue": "A String", # An integer value.
+ "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "nullValue": "A String", # A null value.
+ "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
+ "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
+ },
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -902,24 +1049,7 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": # Object with schema name: Value
- },
- },
+ "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html
index 68130019c47..5bd9b3632f1 100644
--- a/docs/dyn/datastore_v1beta3.projects.html
+++ b/docs/dyn/datastore_v1beta3.projects.html
@@ -232,40 +232,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path.
@@ -283,40 +250,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
@@ -334,40 +268,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
},
@@ -480,40 +381,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -537,40 +405,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -668,7 +503,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -707,7 +559,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -768,7 +637,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -855,40 +741,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -927,7 +780,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html
index 9636dd848af..905e453584f 100644
--- a/docs/dyn/drive_v2.changes.html
+++ b/docs/dyn/drive_v2.changes.html
@@ -305,7 +305,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -814,7 +814,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html
index b78eeef942e..cbc3565af4d 100644
--- a/docs/dyn/drive_v2.files.html
+++ b/docs/dyn/drive_v2.files.html
@@ -293,7 +293,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -678,7 +678,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -1128,7 +1128,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -1527,7 +1527,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -1915,7 +1915,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -2317,7 +2317,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -2714,7 +2714,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -3109,7 +3109,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -3490,7 +3490,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -3871,7 +3871,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -4252,7 +4252,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -4629,7 +4629,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
@@ -5026,7 +5026,7 @@ Method Details
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html
index 10e2824347d..ac0f358b77c 100644
--- a/docs/dyn/drive_v3.changes.html
+++ b/docs/dyn/drive_v3.changes.html
@@ -313,7 +313,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index 1f5844477d2..5b6156ca5bb 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -264,7 +264,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -529,7 +529,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -792,7 +792,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1060,7 +1060,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1391,7 +1391,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1691,7 +1691,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1974,7 +1974,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -2243,7 +2243,7 @@ Method Details
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
+ "owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html
index 58873196aeb..02464f5b2f5 100644
--- a/docs/dyn/firestore_v1.projects.databases.documents.html
+++ b/docs/dyn/firestore_v1.projects.databases.documents.html
@@ -175,7 +175,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -230,31 +234,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -274,7 +263,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -294,7 +287,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -315,26 +312,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -345,7 +323,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -377,31 +359,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -421,7 +388,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -441,7 +412,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -462,26 +437,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -515,7 +471,11 @@ Method Details
{ # The result of applying a write.
"transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -603,31 +563,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -647,7 +592,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -667,7 +616,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -688,26 +641,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -718,7 +652,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -750,31 +688,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -794,7 +717,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -814,7 +741,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -835,26 +766,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -878,7 +790,11 @@ Method Details
{ # The result of applying a write.
"transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -918,7 +834,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -956,7 +876,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1022,7 +946,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1075,7 +1003,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1185,7 +1117,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1233,7 +1169,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1267,7 +1207,11 @@ Method Details
},
"op": "A String", # The operator to filter by.
"value": { # A message that can hold any of the supported value types. # The value to compare to.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1320,7 +1264,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1406,7 +1354,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1454,7 +1406,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1488,7 +1444,11 @@ Method Details
},
"op": "A String", # The operator to filter by.
"value": { # A message that can hold any of the supported value types. # The value to compare to.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1533,7 +1493,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1585,7 +1549,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1625,7 +1593,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1699,7 +1671,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1747,7 +1723,11 @@ Method Details
"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
"values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1781,7 +1761,11 @@ Method Details
},
"op": "A String", # The operator to filter by.
"value": { # A message that can hold any of the supported value types. # The value to compare to.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1825,7 +1809,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1882,31 +1870,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1926,7 +1899,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1946,7 +1923,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -1967,26 +1948,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -1997,7 +1959,11 @@ Method Details
"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
"fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
"a_key": { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -2029,31 +1995,16 @@ Method Details
{ # A transformation of a field of the document.
"appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference.
"increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -2073,7 +2024,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -2093,7 +2048,11 @@ Method Details
"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
},
"minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
@@ -2114,26 +2073,7 @@ Method Details
},
"removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
"values": [ # Values in the array.
- { # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
- "booleanValue": True or False, # A boolean value.
- "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
- "doubleValue": 3.14, # A double value.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "mapValue": { # A map value. # A map value.
- "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
- "a_key": # Object with schema name: Value
- },
- },
- "nullValue": "A String", # A null value.
- "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
- "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
- "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
- },
+ # Object with schema name: Value
],
},
"setToServerValue": "A String", # Sets the field to the given server value.
@@ -2159,7 +2099,11 @@ Method Details
{ # The result of applying a write.
"transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order.
{ # A message that can hold any of the supported value types.
- "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+ "values": [ # Values in the array.
+ # Object with schema name: Value
+ ],
+ },
"booleanValue": True or False, # A boolean value.
"bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
"doubleValue": 3.14, # A double value.
diff --git a/docs/dyn/logging_v2.organizations.html b/docs/dyn/logging_v2.organizations.html
index 61f1f9daa53..f4a19954417 100644
--- a/docs/dyn/logging_v2.organizations.html
+++ b/docs/dyn/logging_v2.organizations.html
@@ -135,7 +135,7 @@ Method Details
Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
Args:
- name: string, Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. (required)
+ name: string, Required. The resource name for the CMEK settings to update. < "projects/PROJECT_ID/cmekSettings" "organizations/ORGANIZATION_ID/cmekSettings" "billingAccounts/BILLING_ACCOUNT_ID/cmekSettings" "folders/FOLDER_ID/cmekSettings"Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/logging_v2.v2.html b/docs/dyn/logging_v2.v2.html
index d6c6b12d38c..5be5a6d33a2 100644
--- a/docs/dyn/logging_v2.v2.html
+++ b/docs/dyn/logging_v2.v2.html
@@ -115,7 +115,7 @@ Method Details
Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
Args:
- name: string, Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. (required)
+ name: string, Required. The resource name for the CMEK settings to update. < "projects/PROJECT_ID/cmekSettings" "organizations/ORGANIZATION_ID/cmekSettings" "billingAccounts/BILLING_ACCOUNT_ID/cmekSettings" "folders/FOLDER_ID/cmekSettings"Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html b/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html
index 879c01af3d0..d53feb920e6 100644
--- a/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html
+++ b/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html
@@ -106,7 +106,7 @@ Method Details
Returns:
An object of the form:
- { # This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).
+ { # This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](/compute/docs/os-configuration-management/view-compliance).
"detailedState": "A String", # Output only. Detailed compliance state of the VM. This field is populated only when compliance state is `UNKNOWN`. It may contain one of the following values: * `no-compliance-data`: Compliance data is not available for this VM. * `no-agent-detected`: OS Config agent is not detected for this VM. * `config-not-supported-by-agent`: The version of the OS Config agent running on this VM does not support configuration management. * `inactive`: VM is not running. * `internal-service-errors`: There were internal service errors encountered while enforcing compliance. * `agent-errors`: OS config agent encountered errors while enforcing compliance.
"detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any).
"instance": "A String", # Output only. The Compute Engine VM instance name.
@@ -125,9 +125,6 @@ Method Details
"type": "A String", # Configuration step type.
},
],
- "execResourceOutput": { # ExecResource specific output. # ExecResource specific output.
- "enforcementOutput": "A String", # Output from Enforcement phase output file (if run). Output size is limited to 100K bytes.
- },
"osPolicyResourceId": "A String", # The id of the OS policy resource.
"state": "A String", # Compliance state of the OS policy resource.
},
@@ -158,7 +155,7 @@ Method Details
{ # A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.
"instanceOsPoliciesCompliances": [ # List of instance OS policies compliance objects.
- { # This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).
+ { # This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](/compute/docs/os-configuration-management/view-compliance).
"detailedState": "A String", # Output only. Detailed compliance state of the VM. This field is populated only when compliance state is `UNKNOWN`. It may contain one of the following values: * `no-compliance-data`: Compliance data is not available for this VM. * `no-agent-detected`: OS Config agent is not detected for this VM. * `config-not-supported-by-agent`: The version of the OS Config agent running on this VM does not support configuration management. * `inactive`: VM is not running. * `internal-service-errors`: There were internal service errors encountered while enforcing compliance. * `agent-errors`: OS config agent encountered errors while enforcing compliance.
"detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any).
"instance": "A String", # Output only. The Compute Engine VM instance name.
@@ -177,9 +174,6 @@ Method Details
"type": "A String", # Configuration step type.
},
],
- "execResourceOutput": { # ExecResource specific output. # ExecResource specific output.
- "enforcementOutput": "A String", # Output from Enforcement phase output file (if run). Output size is limited to 100K bytes.
- },
"osPolicyResourceId": "A String", # The id of the OS policy resource.
"state": "A String", # Compliance state of the OS policy resource.
},
diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html b/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html
index 19398dfa40a..8a359f2dc86 100644
--- a/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html
+++ b/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html
@@ -111,7 +111,7 @@ Method Details
Returns:
An object of the form:
- { # This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).
+ { # This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](/compute/docs/instances/os-inventory-management#data-collected).
"items": { # Output only. Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.
"a_key": { # A single piece of inventory on a VM.
"availablePackage": { # Software package information of the operating system. # Software package available to be installed on the VM instance.
@@ -278,7 +278,7 @@ Method Details
{ # A response message for listing inventory data for all VMs in a specified location.
"inventories": [ # List of inventory objects.
- { # This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).
+ { # This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](/compute/docs/instances/os-inventory-management#data-collected).
"items": { # Output only. Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.
"a_key": { # A single piece of inventory on a VM.
"availablePackage": { # Software package information of the operating system. # Software package available to be installed on the VM instance.
diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html b/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html
index 2547a77654f..e2a38660d0d 100644
--- a/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html
+++ b/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html
@@ -106,7 +106,7 @@ Method Details
Returns:
An object of the form:
- { # This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).
+ { # This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](/compute/docs/instances/os-inventory-management#vulnerability-reports).
"name": "A String", # Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport`
"updateTime": "A String", # Output only. The timestamp for when the last vulnerability report was generated for the VM.
"vulnerabilities": [ # Output only. List of vulnerabilities affecting the VM.
@@ -168,7 +168,7 @@ Method Details
{ # A response message for listing vulnerability reports for all VM instances in the specified location.
"nextPageToken": "A String", # The pagination token to retrieve the next page of vulnerabilityReports object.
"vulnerabilityReports": [ # List of vulnerabilityReport objects.
- { # This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).
+ { # This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](/compute/docs/instances/os-inventory-management#vulnerability-reports).
"name": "A String", # Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport`
"updateTime": "A String", # Output only. The timestamp for when the last vulnerability report was generated for the VM.
"vulnerabilities": [ # Output only. List of vulnerabilities affecting the VM.
diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
index b5091cd0e60..2c24de6ad88 100644
--- a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
+++ b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
@@ -84,10 +84,10 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
-Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
delete(name, x__xgafv=None)
-Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
get(name, x__xgafv=None)
Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.
@@ -105,7 +105,7 @@ Instance Methods
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
-Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Method Details
close()
@@ -114,14 +114,14 @@
Method Details
create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
-
Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+ Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
parent: string, Required. The parent resource name in the form: projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
-{ # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+{ # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies).
"baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
"deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
"description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -179,7 +179,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
"validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
@@ -200,7 +199,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
},
@@ -225,11 +223,11 @@ Method Details
},
"id": "A String", # Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.
"pkg": { # A resource that manages a system package. # Package resource
- "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt.
+ "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt.
"name": "A String", # Required. Package name.
},
"deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb`
"source": { # A remote or local file. # Required. A deb package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -245,11 +243,11 @@ Method Details
},
},
"desiredState": "A String", # Required. The desired state the agent should maintain for this package.
- "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet.
+ "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet.
"name": "A String", # Required. Package name.
},
"msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package.
- "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
+ "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress".
"A String",
],
"source": { # A remote or local file. # Required. The MSI package.
@@ -267,7 +265,7 @@ Method Details
},
},
"rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
"source": { # A remote or local file. # Required. An rpm package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -282,21 +280,21 @@ Method Details
},
},
},
- "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM.
+ "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM.
"name": "A String", # Required. Package name.
},
- "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper.
+ "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper.
"name": "A String", # Required. Package name.
},
},
"repository": { # A resource that manages a package repository. # Package repository resource
- "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.
+ "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository.
"archiveType": "A String", # Required. Type of archive files in this repository.
"components": [ # Required. List of components for this repository. Must contain at least one item.
"A String",
],
"distribution": "A String", # Required. Distribution of this repository.
- "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
+ "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
"uri": "A String", # Required. URI for this repository.
},
"goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository.
@@ -372,7 +370,7 @@ Method Details
delete(name, x__xgafv=None)
-
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+ Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
name: string, Required. The name of the OS policy assignment to be deleted (required)
@@ -419,7 +417,7 @@ Method Details
Returns:
An object of the form:
- { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+ { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies).
"baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
"deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
"description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -477,7 +475,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
"validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
@@ -498,7 +495,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
},
@@ -523,11 +519,11 @@ Method Details
},
"id": "A String", # Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.
"pkg": { # A resource that manages a system package. # Package resource
- "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt.
+ "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt.
"name": "A String", # Required. Package name.
},
"deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb`
"source": { # A remote or local file. # Required. A deb package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -543,11 +539,11 @@ Method Details
},
},
"desiredState": "A String", # Required. The desired state the agent should maintain for this package.
- "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet.
+ "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet.
"name": "A String", # Required. Package name.
},
"msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package.
- "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
+ "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress".
"A String",
],
"source": { # A remote or local file. # Required. The MSI package.
@@ -565,7 +561,7 @@ Method Details
},
},
"rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
"source": { # A remote or local file. # Required. An rpm package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -580,21 +576,21 @@ Method Details
},
},
},
- "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM.
+ "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM.
"name": "A String", # Required. Package name.
},
- "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper.
+ "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper.
"name": "A String", # Required. Package name.
},
},
"repository": { # A resource that manages a package repository. # Package repository resource
- "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.
+ "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository.
"archiveType": "A String", # Required. Type of archive files in this repository.
"components": [ # Required. List of components for this repository. Must contain at least one item.
"A String",
],
"distribution": "A String", # Required. Distribution of this repository.
- "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
+ "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
"uri": "A String", # Required. URI for this repository.
},
"goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository.
@@ -658,7 +654,7 @@ Method Details
{ # A response message for listing all assignments under given parent.
"nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignments.
"osPolicyAssignments": [ # The list of assignments
- { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+ { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies).
"baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
"deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
"description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -716,7 +712,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
"validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
@@ -737,7 +732,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
},
@@ -762,11 +756,11 @@ Method Details
},
"id": "A String", # Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.
"pkg": { # A resource that manages a system package. # Package resource
- "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt.
+ "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt.
"name": "A String", # Required. Package name.
},
"deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb`
"source": { # A remote or local file. # Required. A deb package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -782,11 +776,11 @@ Method Details
},
},
"desiredState": "A String", # Required. The desired state the agent should maintain for this package.
- "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet.
+ "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet.
"name": "A String", # Required. Package name.
},
"msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package.
- "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
+ "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress".
"A String",
],
"source": { # A remote or local file. # Required. The MSI package.
@@ -804,7 +798,7 @@ Method Details
},
},
"rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
"source": { # A remote or local file. # Required. An rpm package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -819,21 +813,21 @@ Method Details
},
},
},
- "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM.
+ "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM.
"name": "A String", # Required. Package name.
},
- "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper.
+ "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper.
"name": "A String", # Required. Package name.
},
},
"repository": { # A resource that manages a package repository. # Package repository resource
- "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.
+ "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository.
"archiveType": "A String", # Required. Type of archive files in this repository.
"components": [ # Required. List of components for this repository. Must contain at least one item.
"A String",
],
"distribution": "A String", # Required. Distribution of this repository.
- "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
+ "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
"uri": "A String", # Required. URI for this repository.
},
"goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository.
@@ -899,7 +893,7 @@ Method Details
{ # A response message for listing all revisions for a OS policy assignment.
"nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignment revisions.
"osPolicyAssignments": [ # The OS policy assignment revisions
- { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+ { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies).
"baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
"deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
"description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -957,7 +951,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
"validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
@@ -978,7 +971,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
},
@@ -1003,11 +995,11 @@ Method Details
},
"id": "A String", # Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.
"pkg": { # A resource that manages a system package. # Package resource
- "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt.
+ "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt.
"name": "A String", # Required. Package name.
},
"deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb`
"source": { # A remote or local file. # Required. A deb package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -1023,11 +1015,11 @@ Method Details
},
},
"desiredState": "A String", # Required. The desired state the agent should maintain for this package.
- "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet.
+ "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet.
"name": "A String", # Required. Package name.
},
"msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package.
- "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
+ "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress".
"A String",
],
"source": { # A remote or local file. # Required. The MSI package.
@@ -1045,7 +1037,7 @@ Method Details
},
},
"rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
"source": { # A remote or local file. # Required. An rpm package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -1060,21 +1052,21 @@ Method Details
},
},
},
- "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM.
+ "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM.
"name": "A String", # Required. Package name.
},
- "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper.
+ "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper.
"name": "A String", # Required. Package name.
},
},
"repository": { # A resource that manages a package repository. # Package repository resource
- "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.
+ "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository.
"archiveType": "A String", # Required. Type of archive files in this repository.
"components": [ # Required. List of components for this repository. Must contain at least one item.
"A String",
],
"distribution": "A String", # Required. Distribution of this repository.
- "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
+ "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
"uri": "A String", # Required. URI for this repository.
},
"goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository.
@@ -1151,14 +1143,14 @@ Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
-
Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+ Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
name: string, Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. (required)
body: object, The request body.
The object takes the form of:
-{ # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+{ # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies).
"baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
"deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
"description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -1216,7 +1208,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
"validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
@@ -1237,7 +1228,6 @@ Method Details
},
},
"interpreter": "A String", # Required. The script interpreter to use.
- "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
"script": "A String", # An inline script. The size of the script is limited to 1024 characters.
},
},
@@ -1262,11 +1252,11 @@ Method Details
},
"id": "A String", # Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.
"pkg": { # A resource that manages a system package. # Package resource
- "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt.
+ "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt.
"name": "A String", # Required. Package name.
},
"deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb`
"source": { # A remote or local file. # Required. A deb package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -1282,11 +1272,11 @@ Method Details
},
},
"desiredState": "A String", # Required. The desired state the agent should maintain for this package.
- "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet.
+ "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet.
"name": "A String", # Required. Package name.
},
"msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package.
- "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
+ "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress".
"A String",
],
"source": { # A remote or local file. # Required. The MSI package.
@@ -1304,7 +1294,7 @@ Method Details
},
},
"rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file.
- "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
+ "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
"source": { # A remote or local file. # Required. An rpm package.
"allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
"gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object.
@@ -1319,21 +1309,21 @@ Method Details
},
},
},
- "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM.
+ "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM.
"name": "A String", # Required. Package name.
},
- "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper.
+ "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper.
"name": "A String", # Required. Package name.
},
},
"repository": { # A resource that manages a package repository. # Package repository resource
- "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.
+ "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository.
"archiveType": "A String", # Required. Type of archive files in this repository.
"components": [ # Required. List of components for this repository. Must contain at least one item.
"A String",
],
"distribution": "A String", # Required. Distribution of this repository.
- "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
+ "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
"uri": "A String", # Required. URI for this repository.
},
"goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
index 17d260f9899..f8cfcddf315 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -182,7 +182,6 @@ Method Details
},
"referrerUri": "A String", # The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
"searchQuery": "A String", # The user's search query. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
- "sessionId": "A String", # Represents the user sessions to aggregate user behavior within a time period. If not set, heuristics will be used to autogenerate one.
"uri": "A String", # Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
"userInfo": { # Information of an end user. # User information.
"directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
index b467fe1d4ef..b53fd817e03 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
@@ -232,7 +232,6 @@ Method Details
},
"referrerUri": "A String", # The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
"searchQuery": "A String", # The user's search query. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
- "sessionId": "A String", # Represents the user sessions to aggregate user behavior within a time period. If not set, heuristics will be used to autogenerate one.
"uri": "A String", # Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
"userInfo": { # Information of an end user. # User information.
"directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
@@ -447,7 +446,6 @@ Method Details
},
"referrerUri": "A String", # The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
"searchQuery": "A String", # The user's search query. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
- "sessionId": "A String", # Represents the user sessions to aggregate user behavior within a time period. If not set, heuristics will be used to autogenerate one.
"uri": "A String", # Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
"userInfo": { # Information of an end user. # User information.
"directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
@@ -543,7 +541,6 @@ Method Details
},
"referrerUri": "A String", # The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
"searchQuery": "A String", # The user's search query. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
- "sessionId": "A String", # Represents the user sessions to aggregate user behavior within a time period. If not set, heuristics will be used to autogenerate one.
"uri": "A String", # Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
"userInfo": { # Information of an end user. # User information.
"directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
diff --git a/docs/dyn/servicecontrol_v2.services.html b/docs/dyn/servicecontrol_v2.services.html
index 566ebeed5db..e8214471dc7 100644
--- a/docs/dyn/servicecontrol_v2.services.html
+++ b/docs/dyn/servicecontrol_v2.services.html
@@ -192,6 +192,8 @@ Method Details
"flags": "A String", # Optional. Contains a comma-separated list of flags.
"resources": [ # Describes the resources and the policies applied to each resource.
{ # Describes a resource referenced in the request.
+ "container": "A String", # Optional. The identifier of the container of this resource. For Google Cloud APIs, the resource container must be one of the following formats: - `projects/` - `folders/` - `organizations/` For the policy enforcement on the container level (VPCSC and Location Policy check), this field takes precedence on the container extracted from name when presents.
+ "location": "A String", # Optional. The location of the resource. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a"
"name": "A String", # The name of the resource referenced in the request.
"permission": "A String", # The resource permission needed for this request. The format must be "{service}/{plural}.{verb}".
"type": "A String", # The resource type in the format of "{service}/{kind}".
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index 5a34d9deee6..936dae878c9 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -421,14 +421,7 @@ Method Details
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
},
},
"params": { # Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
@@ -486,7 +479,11 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ },
},
],
},
@@ -563,14 +560,7 @@ Method Details
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
},
},
"params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
@@ -637,7 +627,11 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ },
},
],
},
@@ -703,14 +697,7 @@ Method Details
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
},
},
"params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
@@ -778,7 +765,11 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ },
},
],
},
@@ -913,14 +904,7 @@ Method Details
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
},
},
"params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
@@ -1176,7 +1160,11 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ },
},
],
},
@@ -1348,7 +1336,11 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ },
},
],
},
diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json
index e3446a47a53..29ad8a25d4f 100644
--- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json
+++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json
@@ -115,7 +115,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"schemas": {
"AmpUrl": {
diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.2.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.2.json
index b6798309201..68a3e0497d7 100644
--- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.2.json
+++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.2.json
@@ -1,596 +1,596 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/F_9WJQnvLgGfABacvXvQLtkcuXw\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.2",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.2",
- "revision": "20180222",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.2/",
- "basePath": "/adexchangebuyer/v1.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.2/",
- "batchPath": "batch/adexchangebuyer/v1.2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "Deprecated. Please use quotaUser instead.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
}
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
}
- }
},
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
+ "basePath": "/adexchangebuyer/v1.2/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.2/",
+ "batchPath": "batch/adexchangebuyer/v1.2",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/Y3VHvV9F_ivZdHVeOCu-9KpBgXg\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
+ "id": "adexchangebuyer:v1.2",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
},
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
},
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
},
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "videoURL": {
- "type": "string",
- "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
+ "quotaUser": {
+ "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
},
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
+ "userIp": {
+ "description": "Deprecated. Please use quotaUser instead.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
}
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
},
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "statusFilter": {
+ "description": "When specified, only creatives having the given status are returned.",
+ "enum": [
+ "approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved.",
+ "Creatives which have been disapproved.",
+ "Creatives whose status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
}
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
}
- }
},
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
+ "revision": "20210526",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
+ "properties": {
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
+ },
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "AccountsList": {
+ "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
+ "id": "AccountsList",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
+ "properties": {
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "All attributes for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "productCategories": {
+ "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Creative serving status. Read-only. This field should not be set in requests.",
+ "type": "string"
+ },
+ "vendorType": {
+ "description": "All vendor types for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
+ "type": "object"
+ },
+ "CreativesList": {
+ "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
+ "id": "CreativesList",
+ "properties": {
+ "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
},
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "adexchangebuyer/v1.2/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.2"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.3.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.3.json
index 9d939d31101..d1a317b896b 100644
--- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.3.json
+++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.3.json
@@ -1,1686 +1,1686 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"F5McR9eEaw0XRpaO3M9gbIugkbs/SfJ_2QNA8p2fWGlW3-bjoNlrlZ0\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.3",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.3",
- "revision": "20191108",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
- "basePath": "/adexchangebuyer/v1.3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.3/",
- "batchPath": "batch/adexchangebuyer/v1.3",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "Deprecated. Please use quotaUser instead.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
}
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
}
- }
},
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
+ "basePath": "/adexchangebuyer/v1.3/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
+ "batchPath": "batch/adexchangebuyer/v1.3",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/NK_Fkylllpd1LFjgYu499Opm5b0\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
- "items": {
+ "id": "adexchangebuyer:v1.3",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
},
- "budgetAmount": {
- "type": "string",
- "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
+ "quotaUser": {
+ "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
},
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
+ "userIp": {
+ "description": "Deprecated. Please use quotaUser instead.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "adTechnologyProviders": {
- "type": "object",
- "properties": {
- "detectedProviderIds": {
- "type": "array",
- "description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "hasUnidentifiedProvider": {
- "type": "boolean",
- "description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines."
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
}
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
},
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
+ "billingInfo": {
+ "methods": {
+ "get": {
+ "description": "Returns the billing information for one account specified by account ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "billinginfo/{accountId}",
+ "response": {
+ "$ref": "BillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.list",
+ "path": "billinginfo",
+ "response": {
+ "$ref": "BillingInfoList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
}
- }
},
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
+ "budget": {
+ "methods": {
+ "get": {
+ "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.budget.get",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.budget.patch",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.budget.update",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
}
- }
},
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "accountId": {
+ "description": "When specified, only creatives for the given account ids are returned.",
+ "format": "int32",
+ "location": "query",
+ "repeated": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "When specified, only creatives for the given buyer creative ids are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "statusFilter": {
+ "description": "When specified, only creatives having the given status are returned.",
+ "enum": [
+ "approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved.",
+ "Creatives which have been disapproved.",
+ "Creatives whose status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- }
}
- }
},
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
- "type": "string"
- }
+ "directDeals": {
+ "methods": {
+ "get": {
+ "description": "Gets one direct deal by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.directDeals.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The direct deal id",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "directdeals/{id}",
+ "response": {
+ "$ref": "DirectDeal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of direct deals.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.directDeals.list",
+ "path": "directdeals",
+ "response": {
+ "$ref": "DirectDealsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
+ "performanceReport": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the authenticated user's list of performance metrics.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.performanceReport.list",
+ "parameterOrder": [
+ "accountId",
+ "endDateTime",
+ "startDateTime"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the reports.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "endDateTime": {
+ "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDateTime": {
+ "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "performancereport",
+ "response": {
+ "$ref": "PerformanceReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "pretargetingConfig": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing pretargeting config.",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer.pretargetingConfig.delete",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to delete the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "url": {
- "type": "string"
+ "get": {
+ "description": "Gets a specific pretargeting configuration",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.get",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "insert": {
+ "description": "Inserts a new pretargeting configuration.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.pretargetingConfig.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to insert the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting configs for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "response": {
+ "$ref": "PretargetingConfigList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing pretargeting config. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.pretargetingConfig.patch",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing pretargeting config.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.pretargetingConfig.update",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- }
- },
- "body": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
- },
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
- },
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ }
+ }
+ },
+ "revision": "20210526",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
+ "properties": {
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "url": {
- "type": "string"
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
}
- }
},
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
+ "type": "object"
+ },
+ "AccountsList": {
+ "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
+ "id": "AccountsList",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
},
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "type": "object"
+ },
+ "BillingInfo": {
+ "description": "The configuration data for an Ad Exchange billing info.",
+ "id": "BillingInfo",
+ "properties": {
+ "accountId": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
},
- "url": {
- "type": "string"
+ "accountName": {
+ "description": "Account name.",
+ "type": "string"
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "billingId": {
+ "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfo",
+ "description": "Resource type.",
+ "type": "string"
}
- }
- },
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
},
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
- }
- }
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DirectDeal": {
- "id": "DirectDeal",
- "type": "object",
- "description": "The configuration data for an Ad Exchange direct deal.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "The account id of the buyer this deal is for.",
- "format": "int32"
- },
- "advertiser": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "allowsAlcohol": {
- "type": "boolean",
- "description": "Whether the publisher for this deal is eligible for alcohol ads."
- },
- "buyerAccountId": {
- "type": "string",
- "description": "The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "dealTier": {
- "type": "string",
- "description": "The deal type such as programmatic reservation or fixed price and so on."
- },
- "endTime": {
- "type": "string",
- "description": "End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.",
- "format": "int64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Deal id.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDeal"
- },
- "name": {
- "type": "string",
- "description": "Deal name."
- },
- "privateExchangeMinCpm": {
- "type": "string",
- "description": "The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).",
- "format": "int64"
- },
- "publisherBlocksOverriden": {
- "type": "boolean",
- "description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal."
- },
- "sellerNetwork": {
- "type": "string",
- "description": "The name of the publisher offering this direct deal."
- },
- "startTime": {
- "type": "string",
- "description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
- "format": "int64"
- }
- }
- },
- "DirectDealsList": {
- "id": "DirectDealsList",
- "type": "object",
- "description": "A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.",
- "properties": {
- "directDeals": {
- "type": "array",
- "description": "A list of direct deals relevant for your account.",
- "items": {
- "$ref": "DirectDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDealsList"
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
+ "type": "object"
},
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
- },
- "performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
- }
- }
- },
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
+ "BillingInfoList": {
+ "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
+ "id": "BillingInfoList",
"properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
- },
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "items": {
+ "description": "A list of billing info relevant for your account.",
+ "items": {
+ "$ref": "BillingInfo"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfoList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
+ "Budget": {
+ "description": "The configuration data for Ad Exchange RTB - Budget API.",
+ "id": "Budget",
"properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "maximumQps": {
- "type": "string",
- "description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
- "format": "int64"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "accountId": {
+ "description": "The id of the account. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "budgetAmount": {
+ "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code for the buyer. This cannot be altered here.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique id that describes this item.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#budget",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
"properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
- },
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "adTechnologyProviders": {
+ "properties": {
+ "detectedProviderIds": {
+ "description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hasUnidentifiedProvider": {
+ "description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "All attributes for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nativeAd": {
+ "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
+ "properties": {
+ "advertiser": {
+ "type": "string"
+ },
+ "appIcon": {
+ "description": "The app icon, for app download ads.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "image": {
+ "description": "A large image.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "impressionTrackingUrl": {
+ "description": "The URLs are called when the impression is rendered.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser logo.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "price": {
+ "description": "The price of the promoted app including the currency info.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "productCategories": {
+ "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Creative serving status. Read-only. This field should not be set in requests.",
+ "type": "string"
+ },
+ "vendorType": {
+ "description": "All vendor types for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "CreativesList": {
+ "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
+ "id": "CreativesList",
+ "properties": {
+ "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
},
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
+ "DirectDeal": {
+ "description": "The configuration data for an Ad Exchange direct deal.",
+ "id": "DirectDeal",
+ "properties": {
+ "accountId": {
+ "description": "The account id of the buyer this deal is for.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "advertiser": {
+ "description": "The name of the advertiser this deal is for.",
+ "type": "string"
+ },
+ "allowsAlcohol": {
+ "description": "Whether the publisher for this deal is eligible for alcohol ads.",
+ "type": "boolean"
+ },
+ "buyerAccountId": {
+ "description": "The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.",
+ "type": "string"
+ },
+ "dealTier": {
+ "description": "The deal type such as programmatic reservation or fixed price and so on.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "fixedCpm": {
+ "description": "The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Deal id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#directDeal",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Deal name.",
+ "type": "string"
+ },
+ "privateExchangeMinCpm": {
+ "description": "The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).",
+ "format": "int64",
+ "type": "string"
+ },
+ "publisherBlocksOverriden": {
+ "description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.",
+ "type": "boolean"
+ },
+ "sellerNetwork": {
+ "description": "The name of the publisher offering this direct deal.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ }
},
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
+ "DirectDealsList": {
+ "description": "A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.",
+ "id": "DirectDealsList",
+ "properties": {
+ "directDeals": {
+ "description": "A list of direct deals relevant for your account.",
+ "items": {
+ "$ref": "DirectDeal"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#directDealsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
},
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "directDeals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.directDeals.get",
- "path": "directdeals/{id}",
- "httpMethod": "GET",
- "description": "Gets one direct deal by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "The direct deal id",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "DirectDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "list": {
- "id": "adexchangebuyer.directDeals.list",
- "path": "directdeals",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of direct deals.",
- "response": {
- "$ref": "DirectDealsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "PerformanceReport": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReport",
+ "properties": {
+ "bidRate": {
+ "description": "The number of bid responses with an ad.",
+ "format": "double",
+ "type": "number"
+ },
+ "bidRequestRate": {
+ "description": "The number of bid requests sent to your bidder.",
+ "format": "double",
+ "type": "number"
+ },
+ "calloutStatusRate": {
+ "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "cookieMatcherStatusRate": {
+ "description": "Average QPS for cookie matcher operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "creativeStatusRate": {
+ "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "filteredBidRate": {
+ "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
+ "format": "double",
+ "type": "number"
+ },
+ "hostedMatchStatusRate": {
+ "description": "Average QPS for hosted match operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "inventoryMatchRate": {
+ "description": "The number of potential queries based on your pretargeting settings.",
+ "format": "double",
+ "type": "number"
+ },
+ "kind": {
+ "default": "adexchangebuyer#performanceReport",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "latency50thPercentile": {
+ "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency85thPercentile": {
+ "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency95thPercentile": {
+ "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "noQuotaInRegion": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "outOfQuota": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchRequests": {
+ "description": "Average QPS for pixel match requests from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchResponses": {
+ "description": "Average QPS for pixel match responses from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaConfiguredLimit": {
+ "description": "The configured quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaThrottledLimit": {
+ "description": "The throttled quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "region": {
+ "description": "The trading location of this data.",
+ "type": "string"
+ },
+ "successfulRequestRate": {
+ "description": "The number of properly formed bid responses received by our servers within the deadline.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The unix timestamp of the starting time of this performance data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "unsuccessfulRequestRate": {
+ "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
+ "format": "double",
+ "type": "number"
+ }
},
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "PerformanceReportList": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReportList",
+ "properties": {
+ "kind": {
+ "default": "adexchangebuyer#performanceReportList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "performanceReport": {
+ "description": "A list of performance reports relevant for the account.",
+ "items": {
+ "$ref": "PerformanceReport"
+ },
+ "type": "array"
+ }
},
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "PretargetingConfig": {
+ "id": "PretargetingConfig",
+ "properties": {
+ "billingId": {
+ "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configId": {
+ "description": "The config id; generated automatically. Leave this field blank for insert requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configName": {
+ "description": "The name of the config. Must be unique. Required for all requests.",
+ "type": "string"
+ },
+ "creativeType": {
+ "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
+ "items": {
+ "properties": {
+ "height": {
+ "description": "Height in pixels.",
+ "format": "int64",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width in pixels.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedContentLabels": {
+ "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedGeoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedPlacements": {
+ "description": "Requests containing any of these placements will not match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedUserLists": {
+ "description": "Requests containing any of these users list ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedVerticals": {
+ "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "geoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "isActive": {
+ "description": "Whether this config is active. Required for all requests.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfig",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Request containing any of these language codes will match.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maximumQps": {
+ "description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
+ "format": "int64",
+ "type": "string"
+ },
+ "mobileCarriers": {
+ "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileDevices": {
+ "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileOperatingSystemVersions": {
+ "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "placements": {
+ "description": "Requests containing any of these placements will match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "platforms": {
+ "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedCreativeAttributes": {
+ "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userLists": {
+ "description": "Requests containing any of these user list ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vendorTypes": {
+ "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "verticals": {
+ "description": "Requests containing any of these vertical ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
},
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
+ "PretargetingConfigList": {
+ "id": "PretargetingConfigList",
+ "properties": {
+ "items": {
+ "description": "A list of pretargeting configs",
+ "items": {
+ "$ref": "PretargetingConfig"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfigList",
+ "description": "Resource type.",
+ "type": "string"
+ }
},
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "adexchangebuyer/v1.3/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.3"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.4.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.4.json
index 46e723d76ea..a091a41e802 100644
--- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.4.json
+++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v1.4.json
@@ -1,3749 +1,3752 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/jgvyhwo-2198NR_j9usHx-LJ-6E\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.4",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.4",
- "revision": "20201004",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
- "basePath": "/adexchangebuyer/v1.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.4/",
- "batchPath": "batch/adexchangebuyer/v1.4",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "Deprecated. Please use quotaUser instead.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "applyPretargetingToNonGuaranteedDeals": {
- "type": "boolean",
- "description": "When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder."
- },
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "bidProtocol": {
- "type": "string",
- "description": "The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_2_5 \n- PROTOCOL_OPENRTB_PROTOBUF_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF_2_5"
- },
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
}
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
- }
- }
- },
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
- },
- "AddOrderDealsRequest": {
- "id": "AddOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "The list of deals to add",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known proposal revision number.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "AddOrderDealsResponse": {
- "id": "AddOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals added (in the same proposal as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the proposal.",
- "format": "int64"
- }
- }
- },
- "AddOrderNotesRequest": {
- "id": "AddOrderNotesRequest",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "The list of notes to add.",
- "items": {
- "$ref": "MarketplaceNote"
- }
}
- }
},
- "AddOrderNotesResponse": {
- "id": "AddOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
- "items": {
+ "basePath": "/adexchangebuyer/v1.4/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
+ "batchPath": "batch/adexchangebuyer/v1.4",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/iKwjFfwd_I-sOBX3ryGQLAoSSXk\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
+ },
+ "id": "adexchangebuyer:v1.4",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
- },
- "budgetAmount": {
- "type": "string",
- "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
- },
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
- }
- }
- },
- "Buyer": {
- "id": "Buyer",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Adx account id of the buyer."
- }
- }
- },
- "ContactInformation": {
- "id": "ContactInformation",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the contact."
- },
- "name": {
- "type": "string",
- "description": "The name of the contact."
- }
- }
- },
- "CreateOrdersRequest": {
- "id": "CreateOrdersRequest",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of proposals to create.",
- "items": {
- "$ref": "Proposal"
- }
- },
- "webPropertyCode": {
- "type": "string",
- "description": "Web property id of the seller creating these orders"
- }
- }
- },
- "CreateOrdersResponse": {
- "id": "CreateOrdersResponse",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of proposals successfully created.",
- "items": {
- "$ref": "Proposal"
- }
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "Deprecated. Please use quotaUser instead.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "adChoicesDestinationUrl": {
- "type": "string",
- "description": "The link to the Ad Preferences page. This is only supported for native ads."
- },
- "adTechnologyProviders": {
- "type": "object",
- "properties": {
- "detectedProviderIds": {
- "type": "array",
- "description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "hasUnidentifiedProvider": {
- "type": "boolean",
- "description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines."
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "confirmUnsafeAccountChange": {
+ "description": "Confirmation for erasing bidder and cookie matching urls.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "confirmUnsafeAccountChange": {
+ "description": "Confirmation for erasing bidder and cookie matching urls.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
}
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "contexts": {
- "type": "array",
- "description": "All known serving contexts containing serving status information.",
- "items": {
- "type": "object",
- "properties": {
- "auctionType": {
- "type": "array",
- "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.",
- "items": {
- "type": "string"
- }
- },
- "contextType": {
- "type": "string",
- "description": "The type of context (e.g., location, platform, auction type, SSL-ness)."
- },
- "geoCriteriaId": {
- "type": "array",
- "description": "Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "platform": {
- "type": "array",
- "description": "Only set when contextType=PLATFORM. Represents the platforms this correction applies to.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
+ },
+ "billingInfo": {
+ "methods": {
+ "get": {
+ "description": "Returns the billing information for one account specified by account ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "billinginfo/{accountId}",
+ "response": {
+ "$ref": "BillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.list",
+ "path": "billinginfo",
+ "response": {
+ "$ref": "BillingInfoList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "budget": {
+ "methods": {
+ "get": {
+ "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.budget.get",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.budget.patch",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.budget.update",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
}
- }
},
- "creativeStatusIdentityType": {
- "type": "string",
- "description": "Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole."
+ "creatives": {
+ "methods": {
+ "addDeal": {
+ "description": "Add a deal id association for the creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.addDeal",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId",
+ "dealId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dealId": {
+ "description": "The id of the deal id to associate with this creative.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "accountId": {
+ "description": "When specified, only creatives for the given account ids are returned.",
+ "format": "int32",
+ "location": "query",
+ "repeated": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "When specified, only creatives for the given buyer creative ids are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dealsStatusFilter": {
+ "description": "When specified, only creatives having the given deals status are returned.",
+ "enum": [
+ "approved",
+ "conditionally_approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved for serving on deals.",
+ "Creatives which have been conditionally approved for serving on deals.",
+ "Creatives which have been disapproved for serving on deals.",
+ "Creatives whose deals status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "openAuctionStatusFilter": {
+ "description": "When specified, only creatives having the given open auction status are returned.",
+ "enum": [
+ "approved",
+ "conditionally_approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved for serving on the open auction.",
+ "Creatives which have been conditionally approved for serving on the open auction.",
+ "Creatives which have been disapproved for serving on the open auction.",
+ "Creatives whose open auction status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "listDeals": {
+ "description": "Lists the external deal ids associated with the creative.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.listDeals",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/listDeals",
+ "response": {
+ "$ref": "CreativeDealIds"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "removeDeal": {
+ "description": "Remove a deal id associated with the creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.removeDeal",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId",
+ "dealId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dealId": {
+ "description": "The id of the deal id to disassociate with this creative.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "dealsStatus": {
- "type": "string",
- "description": "Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly."
+ "marketplacedeals": {
+ "methods": {
+ "delete": {
+ "description": "Delete the specified deals from the proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.delete",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to delete deals from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/delete",
+ "request": {
+ "$ref": "DeleteOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "DeleteOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Add new deals for the specified proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.insert",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "proposalId for which deals need to be added.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/insert",
+ "request": {
+ "$ref": "AddOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "AddOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "List all the deals for a given proposal",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.marketplacedeals.list",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "pqlQuery": {
+ "description": "Query string to retrieve specific deals.",
+ "location": "query",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals",
+ "response": {
+ "$ref": "GetOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Replaces all the deals in the proposal with the passed in deals",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.update",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to edit deals on.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/update",
+ "request": {
+ "$ref": "EditAllOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "EditAllOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "detectedDomains": {
- "type": "array",
- "description": "Detected domains for this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string"
- }
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code as defined in creative-status-codes.txt.",
- "format": "int32"
- }
- }
- }
+ "marketplacenotes": {
+ "methods": {
+ "insert": {
+ "description": "Add notes to the proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacenotes.insert",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to add notes for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/notes/insert",
+ "request": {
+ "$ref": "AddOrderNotesRequest"
+ },
+ "response": {
+ "$ref": "AddOrderNotesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Get all the notes associated with a proposal",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.marketplacenotes.list",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "pqlQuery": {
+ "description": "Query string to retrieve specific notes. To search the text contents of notes, please use syntax like \"WHERE note.note = \"foo\" or \"WHERE note.note LIKE \"%bar%\"",
+ "location": "query",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/notes",
+ "response": {
+ "$ref": "GetOrderNotesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
}
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
- "type": "string"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
+ "marketplaceprivateauction": {
+ "methods": {
+ "updateproposal": {
+ "description": "Update a given private auction proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplaceprivateauction.updateproposal",
+ "parameterOrder": [
+ "privateAuctionId"
+ ],
+ "parameters": {
+ "privateAuctionId": {
+ "description": "The private auction id to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "privateauction/{privateAuctionId}/updateproposal",
+ "request": {
+ "$ref": "UpdatePrivateAuctionProposalRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "languages": {
- "type": "array",
- "description": "Detected languages for this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string"
- }
- },
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "performanceReport": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the authenticated user's list of performance metrics.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.performanceReport.list",
+ "parameterOrder": [
+ "accountId",
+ "endDateTime",
+ "startDateTime"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the reports.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "endDateTime": {
+ "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDateTime": {
+ "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "performancereport",
+ "response": {
+ "$ref": "PerformanceReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "pretargetingConfig": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing pretargeting config.",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer.pretargetingConfig.delete",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to delete the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets a specific pretargeting configuration",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.get",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "url": {
- "type": "string"
+ "insert": {
+ "description": "Inserts a new pretargeting configuration.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.pretargetingConfig.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to insert the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "list": {
+ "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting configs for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "response": {
+ "$ref": "PretargetingConfigList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing pretargeting config. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.pretargetingConfig.patch",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing pretargeting config.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.pretargetingConfig.update",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "products": {
+ "methods": {
+ "get": {
+ "description": "Gets the requested product by id.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.products.get",
+ "parameterOrder": [
+ "productId"
+ ],
+ "parameters": {
+ "productId": {
+ "description": "The id for the product to get the head revision for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "products/{productId}",
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "search": {
+ "description": "Gets the requested product.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.products.search",
+ "parameters": {
+ "pqlQuery": {
+ "description": "The pql query used to query for products.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "products/search",
+ "response": {
+ "$ref": "GetOffersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "proposals": {
+ "methods": {
+ "get": {
+ "description": "Get a proposal given its id",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.proposals.get",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "Id of the proposal to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}",
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Create the given list of proposals",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.proposals.insert",
+ "path": "proposals/insert",
+ "request": {
+ "$ref": "CreateOrdersRequest"
+ },
+ "response": {
+ "$ref": "CreateOrdersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Update the given proposal. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.proposals.patch",
+ "parameterOrder": [
+ "proposalId",
+ "revisionNumber",
+ "updateAction"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
+ "enum": [
+ "accept",
+ "cancel",
+ "propose",
+ "proposeAndAccept",
+ "unknownAction",
+ "updateNonTerms"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
+ "request": {
+ "$ref": "Proposal"
+ },
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "search": {
+ "description": "Search for proposals using pql query",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.proposals.search",
+ "parameters": {
+ "pqlQuery": {
+ "description": "Query string to retrieve specific proposals.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "proposals/search",
+ "response": {
+ "$ref": "GetOrdersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "setupcomplete": {
+ "description": "Update the given proposal to indicate that setup has been completed.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.proposals.setupcomplete",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id for which the setup is complete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/setupcomplete",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Update the given proposal",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.proposals.update",
+ "parameterOrder": [
+ "proposalId",
+ "revisionNumber",
+ "updateAction"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
+ "enum": [
+ "accept",
+ "cancel",
+ "propose",
+ "proposeAndAccept",
+ "unknownAction",
+ "updateNonTerms"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
+ "request": {
+ "$ref": "Proposal"
+ },
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "pubprofiles": {
+ "methods": {
+ "list": {
+ "description": "Gets the requested publisher profile(s) by publisher accountId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pubprofiles.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The accountId of the publisher to get profiles for.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "publisher/{accountId}/profiles",
+ "response": {
+ "$ref": "GetPublisherProfilesByAccountIdResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210526",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
+ "properties": {
+ "applyPretargetingToNonGuaranteedDeals": {
+ "description": "When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder.",
+ "type": "boolean"
+ },
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "bidProtocol": {
+ "description": "The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_2_5 \n- PROTOCOL_OPENRTB_PROTOBUF_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF_2_5",
+ "type": "string"
+ },
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
+ },
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
}
- }
},
- "body": {
- "type": "string",
- "description": "A long description of the ad."
+ "type": "object"
+ },
+ "AccountsList": {
+ "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
+ "id": "AccountsList",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
},
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
+ "type": "object"
+ },
+ "AddOrderDealsRequest": {
+ "id": "AddOrderDealsRequest",
+ "properties": {
+ "deals": {
+ "description": "The list of deals to add",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known proposal revision number.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
},
- "clickLinkUrl": {
- "type": "string",
- "description": "The URL that the browser/SDK will load when the user clicks the ad."
+ "type": "object"
+ },
+ "AddOrderDealsResponse": {
+ "id": "AddOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals added (in the same proposal as passed in the request)",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The updated revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ }
},
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
+ "type": "object"
+ },
+ "AddOrderNotesRequest": {
+ "id": "AddOrderNotesRequest",
+ "properties": {
+ "notes": {
+ "description": "The list of notes to add.",
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
},
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
+ "type": "object"
+ },
+ "AddOrderNotesResponse": {
+ "id": "AddOrderNotesResponse",
+ "properties": {
+ "notes": {
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
},
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "type": "object"
+ },
+ "BillingInfo": {
+ "description": "The configuration data for an Ad Exchange billing info.",
+ "id": "BillingInfo",
+ "properties": {
+ "accountId": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
},
- "url": {
- "type": "string"
+ "accountName": {
+ "description": "Account name.",
+ "type": "string"
},
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
- },
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "billingId": {
+ "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "url": {
- "type": "string"
+ "kind": {
+ "default": "adexchangebuyer#billingInfo",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BillingInfoList": {
+ "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
+ "id": "BillingInfoList",
+ "properties": {
+ "items": {
+ "description": "A list of billing info relevant for your account.",
+ "items": {
+ "$ref": "BillingInfo"
+ },
+ "type": "array"
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "kind": {
+ "default": "adexchangebuyer#billingInfoList",
+ "description": "Resource type.",
+ "type": "string"
}
- }
},
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
+ "type": "object"
+ },
+ "Budget": {
+ "description": "The configuration data for Ad Exchange RTB - Budget API.",
+ "id": "Budget",
+ "properties": {
+ "accountId": {
+ "description": "The id of the account. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "budgetAmount": {
+ "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code for the buyer. This cannot be altered here.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique id that describes this item.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#budget",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
+ "type": "string"
+ }
},
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
+ "type": "object"
+ },
+ "Buyer": {
+ "id": "Buyer",
+ "properties": {
+ "accountId": {
+ "description": "Adx account id of the buyer.",
+ "type": "string"
+ }
},
- "videoURL": {
- "type": "string",
- "description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url."
- }
- }
- },
- "openAuctionStatus": {
- "type": "string",
- "description": "Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly."
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "servingRestrictions": {
- "type": "array",
- "description": "The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.",
- "items": {
- "type": "object",
- "properties": {
- "contexts": {
- "type": "array",
- "description": "All known contexts/restrictions.",
- "items": {
- "type": "object",
- "properties": {
- "auctionType": {
- "type": "array",
- "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.",
- "items": {
- "type": "string"
- }
- },
- "contextType": {
- "type": "string",
- "description": "The type of context (e.g., location, platform, auction type, SSL-ness)."
- },
- "geoCriteriaId": {
- "type": "array",
- "description": "Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "platform": {
- "type": "array",
- "description": "Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.",
+ "type": "object"
+ },
+ "ContactInformation": {
+ "id": "ContactInformation",
+ "properties": {
+ "email": {
+ "description": "Email address of the contact.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the contact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateOrdersRequest": {
+ "id": "CreateOrdersRequest",
+ "properties": {
+ "proposals": {
+ "description": "The list of proposals to create.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ },
+ "webPropertyCode": {
+ "description": "Web property id of the seller creating these orders",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateOrdersResponse": {
+ "id": "CreateOrdersResponse",
+ "properties": {
+ "proposals": {
+ "description": "The list of proposals successfully created.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
+ "properties": {
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "adChoicesDestinationUrl": {
+ "description": "The link to the Ad Preferences page. This is only supported for native ads.",
+ "type": "string"
+ },
+ "adTechnologyProviders": {
+ "properties": {
+ "detectedProviderIds": {
+ "description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hasUnidentifiedProvider": {
+ "description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "contexts": {
+ "description": "All known serving contexts containing serving status information.",
+ "items": {
+ "properties": {
+ "auctionType": {
+ "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contextType": {
+ "description": "The type of context (e.g., location, platform, auction type, SSL-ness).",
+ "type": "string"
+ },
+ "geoCriteriaId": {
+ "description": "Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "platform": {
+ "description": "Only set when contextType=PLATFORM. Represents the platforms this correction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "creativeStatusIdentityType": {
+ "description": "Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.",
+ "type": "string"
+ },
+ "dealsStatus": {
+ "description": "Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.",
+ "type": "string"
+ },
+ "detectedDomains": {
+ "description": "Detected domains for this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code as defined in creative-status-codes.txt.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Detected languages for this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "nativeAd": {
+ "description": "If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)",
+ "properties": {
+ "advertiser": {
+ "type": "string"
+ },
+ "appIcon": {
+ "description": "The app icon, for app download ads.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "image": {
+ "description": "A large image.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "impressionTrackingUrl": {
+ "description": "The URLs are called when the impression is rendered.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser logo.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "price": {
+ "description": "The price of the promoted app including the currency info.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "videoURL": {
+ "description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "openAuctionStatus": {
+ "description": "Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.",
+ "type": "string"
+ },
+ "productCategories": {
+ "description": "Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "servingRestrictions": {
+ "description": "The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.",
+ "items": {
+ "properties": {
+ "contexts": {
+ "description": "All known contexts/restrictions.",
+ "items": {
+ "properties": {
+ "auctionType": {
+ "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contextType": {
+ "description": "The type of context (e.g., location, platform, auction type, SSL-ness).",
+ "type": "string"
+ },
+ "geoCriteriaId": {
+ "description": "Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "platform": {
+ "description": "Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "vendorType": {
+ "description": "List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.",
+ "type": "string"
+ },
+ "videoVastXML": {
+ "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeDealIds": {
+ "description": "The external deal ids associated with a creative.",
+ "id": "CreativeDealIds",
+ "properties": {
+ "dealStatuses": {
+ "description": "A list of external deal ids and ARC approval status.",
+ "items": {
+ "properties": {
+ "arcStatus": {
+ "description": "ARC approval status.",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "External deal ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Publisher ID.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativeDealIds",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativesList": {
+ "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
+ "id": "CreativesList",
+ "properties": {
"items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealServingMetadata": {
+ "id": "DealServingMetadata",
+ "properties": {
+ "alcoholAdsAllowed": {
+ "description": "True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals",
+ "type": "boolean"
+ },
+ "dealPauseStatus": {
+ "$ref": "DealServingMetadataDealPauseStatus",
+ "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)"
+ }
+ },
+ "type": "object"
+ },
+ "DealServingMetadataDealPauseStatus": {
+ "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently.",
+ "id": "DealServingMetadataDealPauseStatus",
+ "properties": {
+ "buyerPauseReason": {
+ "type": "string"
+ },
+ "firstPausedBy": {
+ "description": "If the deal is paused, records which party paused the deal first.",
+ "type": "string"
+ },
+ "hasBuyerPaused": {
+ "type": "boolean"
+ },
+ "hasSellerPaused": {
+ "type": "boolean"
+ },
+ "sellerPauseReason": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTerms": {
+ "id": "DealTerms",
+ "properties": {
+ "brandingType": {
+ "description": "Visibility of the URL in bid requests.",
+ "type": "string"
+ },
+ "crossListedExternalDealIdType": {
+ "description": "Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description for the proposed terms of the deal.",
+ "type": "string"
+ },
+ "estimatedGrossSpend": {
+ "$ref": "Price",
+ "description": "Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller."
+ },
+ "estimatedImpressionsPerDay": {
+ "description": "Non-binding estimate of the impressions served per day Can be set by buyer or seller.",
+ "format": "int64",
+ "type": "string"
+ },
+ "guaranteedFixedPriceTerms": {
+ "$ref": "DealTermsGuaranteedFixedPriceTerms",
+ "description": "The terms for guaranteed fixed price deals."
+ },
+ "nonGuaranteedAuctionTerms": {
+ "$ref": "DealTermsNonGuaranteedAuctionTerms",
+ "description": "The terms for non-guaranteed auction deals."
+ },
+ "nonGuaranteedFixedPriceTerms": {
+ "$ref": "DealTermsNonGuaranteedFixedPriceTerms",
+ "description": "The terms for non-guaranteed fixed price deals."
+ },
+ "rubiconNonGuaranteedTerms": {
+ "$ref": "DealTermsRubiconNonGuaranteedTerms",
+ "description": "The terms for rubicon non-guaranteed deals."
+ },
+ "sellerTimeZone": {
+ "description": "For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsGuaranteedFixedPriceTerms": {
+ "id": "DealTermsGuaranteedFixedPriceTerms",
+ "properties": {
+ "billingInfo": {
+ "$ref": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
+ "description": "External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX."
+ },
+ "fixedPrices": {
+ "description": "Fixed price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ },
+ "guaranteedImpressions": {
+ "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.",
+ "format": "int64",
+ "type": "string"
+ },
+ "guaranteedLooks": {
+ "description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minimumDailyLooks": {
+ "description": "Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsGuaranteedFixedPriceTermsBillingInfo": {
+ "id": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
+ "properties": {
+ "currencyConversionTimeMs": {
+ "description": "The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dfpLineItemId": {
+ "description": "The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "originalContractedQuantity": {
+ "description": "The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.",
+ "format": "int64",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The original reservation price for the deal, if the currency code is different from the one used in negotiation."
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsNonGuaranteedAuctionTerms": {
+ "id": "DealTermsNonGuaranteedAuctionTerms",
+ "properties": {
+ "autoOptimizePrivateAuction": {
+ "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).",
+ "type": "boolean"
+ },
+ "reservePricePerBuyers": {
+ "description": "Reserve price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsNonGuaranteedFixedPriceTerms": {
+ "id": "DealTermsNonGuaranteedFixedPriceTerms",
+ "properties": {
+ "fixedPrices": {
+ "description": "Fixed price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsRubiconNonGuaranteedTerms": {
+ "id": "DealTermsRubiconNonGuaranteedTerms",
+ "properties": {
+ "priorityPrice": {
+ "$ref": "Price",
+ "description": "Optional price for Rubicon priority access in the auction."
+ },
+ "standardPrice": {
+ "$ref": "Price",
+ "description": "Optional price for Rubicon standard access in the auction."
+ }
+ },
+ "type": "object"
+ },
+ "DeleteOrderDealsRequest": {
+ "id": "DeleteOrderDealsRequest",
+ "properties": {
+ "dealIds": {
+ "description": "List of deals to delete for a given proposal",
+ "items": {
"type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "reason": {
- "type": "string",
- "description": "Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review)."
- }
- }
- }
- },
- "vendorType": {
- "type": "array",
- "description": "List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above."
- },
- "videoVastXML": {
- "type": "string",
- "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativeDealIds": {
- "id": "CreativeDealIds",
- "type": "object",
- "description": "The external deal ids associated with a creative.",
- "properties": {
- "dealStatuses": {
- "type": "array",
- "description": "A list of external deal ids and ARC approval status.",
- "items": {
- "type": "object",
- "properties": {
- "arcStatus": {
- "type": "string",
- "description": "ARC approval status."
- },
- "dealId": {
- "type": "string",
- "description": "External deal ID.",
- "format": "int64"
- },
- "webPropertyId": {
- "type": "integer",
- "description": "Publisher ID.",
- "format": "int32"
- }
- }
- }
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known proposal revision number.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativeDealIds"
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DealServingMetadata": {
- "id": "DealServingMetadata",
- "type": "object",
- "properties": {
- "alcoholAdsAllowed": {
- "type": "boolean",
- "description": "True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals"
- },
- "dealPauseStatus": {
- "$ref": "DealServingMetadataDealPauseStatus",
- "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)"
- }
- }
- },
- "DealServingMetadataDealPauseStatus": {
- "id": "DealServingMetadataDealPauseStatus",
- "type": "object",
- "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently.",
- "properties": {
- "buyerPauseReason": {
- "type": "string"
- },
- "firstPausedBy": {
- "type": "string",
- "description": "If the deal is paused, records which party paused the deal first."
- },
- "hasBuyerPaused": {
- "type": "boolean"
- },
- "hasSellerPaused": {
- "type": "boolean"
- },
- "sellerPauseReason": {
- "type": "string"
- }
- }
- },
- "DealTerms": {
- "id": "DealTerms",
- "type": "object",
- "properties": {
- "brandingType": {
- "type": "string",
- "description": "Visibility of the URL in bid requests."
- },
- "crossListedExternalDealIdType": {
- "type": "string",
- "description": "Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case."
- },
- "description": {
- "type": "string",
- "description": "Description for the proposed terms of the deal."
- },
- "estimatedGrossSpend": {
- "$ref": "Price",
- "description": "Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller."
- },
- "estimatedImpressionsPerDay": {
- "type": "string",
- "description": "Non-binding estimate of the impressions served per day Can be set by buyer or seller.",
- "format": "int64"
- },
- "guaranteedFixedPriceTerms": {
- "$ref": "DealTermsGuaranteedFixedPriceTerms",
- "description": "The terms for guaranteed fixed price deals."
- },
- "nonGuaranteedAuctionTerms": {
- "$ref": "DealTermsNonGuaranteedAuctionTerms",
- "description": "The terms for non-guaranteed auction deals."
- },
- "nonGuaranteedFixedPriceTerms": {
- "$ref": "DealTermsNonGuaranteedFixedPriceTerms",
- "description": "The terms for non-guaranteed fixed price deals."
- },
- "rubiconNonGuaranteedTerms": {
- "$ref": "DealTermsRubiconNonGuaranteedTerms",
- "description": "The terms for rubicon non-guaranteed deals."
- },
- "sellerTimeZone": {
- "type": "string",
- "description": "For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)"
- }
- }
- },
- "DealTermsGuaranteedFixedPriceTerms": {
- "id": "DealTermsGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "billingInfo": {
- "$ref": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
- "description": "External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX."
- },
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- },
- "guaranteedImpressions": {
- "type": "string",
- "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.",
- "format": "int64"
- },
- "guaranteedLooks": {
- "type": "string",
- "description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.",
- "format": "int64"
- },
- "minimumDailyLooks": {
- "type": "string",
- "description": "Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.",
- "format": "int64"
- }
- }
- },
- "DealTermsGuaranteedFixedPriceTermsBillingInfo": {
- "id": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
- "type": "object",
- "properties": {
- "currencyConversionTimeMs": {
- "type": "string",
- "description": "The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.",
- "format": "int64"
- },
- "dfpLineItemId": {
- "type": "string",
- "description": "The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.",
- "format": "int64"
- },
- "originalContractedQuantity": {
- "type": "string",
- "description": "The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.",
- "format": "int64"
- },
- "price": {
- "$ref": "Price",
- "description": "The original reservation price for the deal, if the currency code is different from the one used in negotiation."
- }
- }
- },
- "DealTermsNonGuaranteedAuctionTerms": {
- "id": "DealTermsNonGuaranteedAuctionTerms",
- "type": "object",
- "properties": {
- "autoOptimizePrivateAuction": {
- "type": "boolean",
- "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly)."
- },
- "reservePricePerBuyers": {
- "type": "array",
- "description": "Reserve price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DealTermsNonGuaranteedFixedPriceTerms": {
- "id": "DealTermsNonGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DealTermsRubiconNonGuaranteedTerms": {
- "id": "DealTermsRubiconNonGuaranteedTerms",
- "type": "object",
- "properties": {
- "priorityPrice": {
- "$ref": "Price",
- "description": "Optional price for Rubicon priority access in the auction."
- },
- "standardPrice": {
- "$ref": "Price",
- "description": "Optional price for Rubicon standard access in the auction."
- }
- }
- },
- "DeleteOrderDealsRequest": {
- "id": "DeleteOrderDealsRequest",
- "type": "object",
- "properties": {
- "dealIds": {
- "type": "array",
- "description": "List of deals to delete for a given proposal",
- "items": {
- "type": "string"
- }
+ "DeleteOrderDealsResponse": {
+ "id": "DeleteOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals deleted (in the same proposal as passed in the request)",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The updated revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeliveryControl": {
+ "id": "DeliveryControl",
+ "properties": {
+ "creativeBlockingLevel": {
+ "type": "string"
+ },
+ "deliveryRateType": {
+ "type": "string"
+ },
+ "frequencyCaps": {
+ "items": {
+ "$ref": "DeliveryControlFrequencyCap"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DeliveryControlFrequencyCap": {
+ "id": "DeliveryControlFrequencyCap",
+ "properties": {
+ "maxImpressions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "numTimeUnits": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timeUnitType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}",
+ "id": "Dimension",
+ "properties": {
+ "dimensionType": {
+ "type": "string"
+ },
+ "dimensionValues": {
+ "items": {
+ "$ref": "DimensionDimensionValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionDimensionValue": {
+ "description": "Value of the dimension.",
+ "id": "DimensionDimensionValue",
+ "properties": {
+ "id": {
+ "description": "Id of the dimension.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.",
+ "type": "string"
+ },
+ "percentage": {
+ "description": "Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EditAllOrderDealsRequest": {
+ "id": "EditAllOrderDealsRequest",
+ "properties": {
+ "deals": {
+ "description": "List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposal": {
+ "$ref": "Proposal",
+ "description": "If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction."
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EditAllOrderDealsResponse": {
+ "id": "EditAllOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of all deals in the proposal after edit.",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "orderRevisionNumber": {
+ "description": "The latest revision number after the update has been applied.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetOffersResponse": {
+ "id": "GetOffersResponse",
+ "properties": {
+ "products": {
+ "description": "The returned list of products.",
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrderDealsResponse": {
+ "id": "GetOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals for the proposal",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrderNotesResponse": {
+ "id": "GetOrderNotesResponse",
+ "properties": {
+ "notes": {
+ "description": "The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.",
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrdersResponse": {
+ "id": "GetOrdersResponse",
+ "properties": {
+ "proposals": {
+ "description": "The list of matching proposals.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetPublisherProfilesByAccountIdResponse": {
+ "id": "GetPublisherProfilesByAccountIdResponse",
+ "properties": {
+ "profiles": {
+ "description": "Profiles for the requested publisher",
+ "items": {
+ "$ref": "PublisherProfileApiProto"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceDeal": {
+ "description": "A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
+ "id": "MarketplaceDeal",
+ "properties": {
+ "buyerPrivateData": {
+ "$ref": "PrivateData",
+ "description": "Buyer private data (hidden from seller)."
+ },
+ "creationTimeMs": {
+ "description": "The time (ms since epoch) of the deal creation. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativePreApprovalPolicy": {
+ "description": "Specifies the creative pre-approval policy (buyer-readonly)",
+ "type": "string"
+ },
+ "creativeSafeFrameCompatibility": {
+ "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "A unique deal-id for the deal (readonly).",
+ "type": "string"
+ },
+ "dealServingMetadata": {
+ "$ref": "DealServingMetadata",
+ "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)"
+ },
+ "deliveryControl": {
+ "$ref": "DeliveryControl",
+ "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
+ },
+ "externalDealId": {
+ "description": "The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)",
+ "type": "string"
+ },
+ "flightEndTimeMs": {
+ "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
+ "format": "int64",
+ "type": "string"
+ },
+ "flightStartTimeMs": {
+ "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
+ "format": "int64",
+ "type": "string"
+ },
+ "inventoryDescription": {
+ "description": "Description for the deal terms. (buyer-readonly)",
+ "type": "string"
+ },
+ "isRfpTemplate": {
+ "description": "Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.",
+ "type": "boolean"
+ },
+ "isSetupComplete": {
+ "description": "True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action)",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#marketplaceDeal",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
+ "type": "string"
+ },
+ "lastUpdateTimeMs": {
+ "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "makegoodRequestedReason": {
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the deal. (updatable)",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The product-id from which this deal was created. (readonly, except on create)",
+ "type": "string"
+ },
+ "productRevisionNumber": {
+ "description": "The revision number of the product that the deal was created from (readonly, except on create)",
+ "format": "int64",
+ "type": "string"
+ },
+ "programmaticCreativeSource": {
+ "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)",
+ "type": "string"
+ },
+ "proposalId": {
+ "type": "string"
+ },
+ "sellerContacts": {
+ "description": "Optional Seller contact information for the deal (buyer-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "sharedTargetings": {
+ "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)",
+ "items": {
+ "$ref": "SharedTargeting"
+ },
+ "type": "array"
+ },
+ "syndicationProduct": {
+ "description": "The syndication product associated with the deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "terms": {
+ "$ref": "DealTerms",
+ "description": "The negotiable terms of the deal. (updatable)"
+ },
+ "webPropertyCode": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceDealParty": {
+ "id": "MarketplaceDealParty",
+ "properties": {
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party."
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party."
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceLabel": {
+ "id": "MarketplaceLabel",
+ "properties": {
+ "accountId": {
+ "description": "The accountId of the party that created the label.",
+ "type": "string"
+ },
+ "createTimeMs": {
+ "description": "The creation time (in ms since epoch) for the label.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deprecatedMarketplaceDealParty": {
+ "$ref": "MarketplaceDealParty",
+ "description": "Information about the party that created the label."
+ },
+ "label": {
+ "description": "The label to use.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceNote": {
+ "description": "A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.",
+ "id": "MarketplaceNote",
+ "properties": {
+ "creatorRole": {
+ "description": "The role of the person (buyer/seller) creating the note. (readonly)",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "Notes can optionally be associated with a deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#marketplaceNote",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceNote\".",
+ "type": "string"
+ },
+ "note": {
+ "description": "The actual note to attach. (readonly, except on create)",
+ "type": "string"
+ },
+ "noteId": {
+ "description": "The unique id for the note. (readonly)",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId that a note is attached to. (readonly)",
+ "type": "string"
+ },
+ "proposalRevisionNumber": {
+ "description": "If the note is associated with a proposal revision number, then store that here. (readonly, except on create)",
+ "format": "int64",
+ "type": "string"
+ },
+ "timestampMs": {
+ "description": "The timestamp (ms since epoch) that this note was created. (readonly)",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileApplication": {
+ "id": "MobileApplication",
+ "properties": {
+ "appStore": {
+ "type": "string"
+ },
+ "externalAppId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReport": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReport",
+ "properties": {
+ "bidRate": {
+ "description": "The number of bid responses with an ad.",
+ "format": "double",
+ "type": "number"
+ },
+ "bidRequestRate": {
+ "description": "The number of bid requests sent to your bidder.",
+ "format": "double",
+ "type": "number"
+ },
+ "calloutStatusRate": {
+ "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "cookieMatcherStatusRate": {
+ "description": "Average QPS for cookie matcher operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "creativeStatusRate": {
+ "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "filteredBidRate": {
+ "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
+ "format": "double",
+ "type": "number"
+ },
+ "hostedMatchStatusRate": {
+ "description": "Average QPS for hosted match operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "inventoryMatchRate": {
+ "description": "The number of potential queries based on your pretargeting settings.",
+ "format": "double",
+ "type": "number"
+ },
+ "kind": {
+ "default": "adexchangebuyer#performanceReport",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "latency50thPercentile": {
+ "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency85thPercentile": {
+ "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency95thPercentile": {
+ "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "noQuotaInRegion": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "outOfQuota": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchRequests": {
+ "description": "Average QPS for pixel match requests from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchResponses": {
+ "description": "Average QPS for pixel match responses from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaConfiguredLimit": {
+ "description": "The configured quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaThrottledLimit": {
+ "description": "The throttled quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "region": {
+ "description": "The trading location of this data.",
+ "type": "string"
+ },
+ "successfulRequestRate": {
+ "description": "The number of properly formed bid responses received by our servers within the deadline.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The unix timestamp of the starting time of this performance data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "unsuccessfulRequestRate": {
+ "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReportList": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReportList",
+ "properties": {
+ "kind": {
+ "default": "adexchangebuyer#performanceReportList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "performanceReport": {
+ "description": "A list of performance reports relevant for the account.",
+ "items": {
+ "$ref": "PerformanceReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfig": {
+ "id": "PretargetingConfig",
+ "properties": {
+ "billingId": {
+ "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configId": {
+ "description": "The config id; generated automatically. Leave this field blank for insert requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configName": {
+ "description": "The name of the config. Must be unique. Required for all requests.",
+ "type": "string"
+ },
+ "creativeType": {
+ "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
+ "items": {
+ "properties": {
+ "height": {
+ "description": "Height in pixels.",
+ "format": "int64",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width in pixels.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedContentLabels": {
+ "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedGeoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedPlacements": {
+ "description": "Requests containing any of these placements will not match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedUserLists": {
+ "description": "Requests containing any of these users list ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedVerticals": {
+ "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "geoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "isActive": {
+ "description": "Whether this config is active. Required for all requests.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfig",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Request containing any of these language codes will match.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maximumQps": {
+ "description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
+ "format": "int64",
+ "type": "string"
+ },
+ "minimumViewabilityDecile": {
+ "description": "Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "mobileCarriers": {
+ "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileDevices": {
+ "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileOperatingSystemVersions": {
+ "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "placements": {
+ "description": "Requests containing any of these placements will match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "platforms": {
+ "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedCreativeAttributes": {
+ "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userIdentifierDataRequired": {
+ "description": "Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userLists": {
+ "description": "Requests containing any of these user list ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vendorTypes": {
+ "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "verticals": {
+ "description": "Requests containing any of these vertical ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "videoPlayerSizes": {
+ "description": "Video requests satisfying any of these player size constraints will match.",
+ "items": {
+ "properties": {
+ "aspectRatio": {
+ "description": "The type of aspect ratio. Leave this field blank to match all aspect ratios.",
+ "type": "string"
+ },
+ "minHeight": {
+ "description": "The minimum player height in pixels. Leave this field blank to match any player height.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minWidth": {
+ "description": "The minimum player width in pixels. Leave this field blank to match any player width.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfigList": {
+ "id": "PretargetingConfigList",
+ "properties": {
+ "items": {
+ "description": "A list of pretargeting configs",
+ "items": {
+ "$ref": "PretargetingConfig"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfigList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Price": {
+ "id": "Price",
+ "properties": {
+ "amountMicros": {
+ "description": "The price value in micros.",
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "description": "The currency code for the price.",
+ "type": "string"
+ },
+ "expectedCpmMicros": {
+ "description": "In case of CPD deals, the expected CPM in micros.",
+ "format": "double",
+ "type": "number"
+ },
+ "pricingType": {
+ "description": "The pricing type for the deal/product.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricePerBuyer": {
+ "description": "Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.",
+ "id": "PricePerBuyer",
+ "properties": {
+ "auctionTier": {
+ "description": "Optional access type for this buyer.",
+ "type": "string"
+ },
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer that will get billed."
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer)."
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The specified price"
+ }
+ },
+ "type": "object"
+ },
+ "PrivateData": {
+ "id": "PrivateData",
+ "properties": {
+ "referenceId": {
+ "type": "string"
+ },
+ "referencePayload": {
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Product": {
+ "description": "A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
+ "id": "Product",
+ "properties": {
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)"
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)"
+ },
+ "creationTimeMs": {
+ "description": "Creation time in ms. since epoch (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "creatorContacts": {
+ "description": "Optional contact information for the creator of this product. (buyer-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "creatorRole": {
+ "description": "The role that created the offer. Set to BUYER for buyer initiated offers.",
+ "type": "string"
+ },
+ "deliveryControl": {
+ "$ref": "DeliveryControl",
+ "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
+ },
+ "flightEndTimeMs": {
+ "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "flightStartTimeMs": {
+ "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "hasCreatorSignedOff": {
+ "description": "If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.",
+ "type": "boolean"
+ },
+ "inventorySource": {
+ "description": "What exchange will provide this inventory (readonly, except on create).",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#product",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#product\".",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Optional List of labels for the product (optional, buyer-readonly).",
+ "items": {
+ "$ref": "MarketplaceLabel"
+ },
+ "type": "array"
+ },
+ "lastUpdateTimeMs": {
+ "description": "Time of last update in ms. since epoch (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "legacyOfferId": {
+ "description": "Optional legacy offer id if this offer is a preferred deal offer.",
+ "type": "string"
+ },
+ "marketplacePublisherProfileId": {
+ "description": "Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name for this product as set by the seller. (buyer-readonly)",
+ "type": "string"
+ },
+ "privateAuctionId": {
+ "description": "Optional private auction id if this offer is a private auction offer.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The unique id for the product (readonly)",
+ "type": "string"
+ },
+ "publisherProfileId": {
+ "description": "Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.",
+ "type": "string"
+ },
+ "publisherProvidedForecast": {
+ "$ref": "PublisherProvidedForecast",
+ "description": "Publisher self-provided forecast information."
+ },
+ "revisionNumber": {
+ "description": "The revision number of the product. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Information about the seller that created this product (readonly, except on create)"
+ },
+ "sharedTargetings": {
+ "description": "Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)",
+ "items": {
+ "$ref": "SharedTargeting"
+ },
+ "type": "array"
+ },
+ "state": {
+ "description": "The state of the product. (buyer-readonly)",
+ "type": "string"
+ },
+ "syndicationProduct": {
+ "description": "The syndication product associated with the deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "terms": {
+ "$ref": "DealTerms",
+ "description": "The negotiable terms of the deal (buyer-readonly)"
+ },
+ "webPropertyCode": {
+ "description": "The web property code for the seller. This field is meant to be copied over as is when creating deals.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Proposal": {
+ "description": "Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
+ "id": "Proposal",
+ "properties": {
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer that will get billed for this proposal. (readonly)"
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer on the proposal. (readonly, except on create)"
+ },
+ "buyerContacts": {
+ "description": "Optional contact information of the buyer. (seller-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "buyerPrivateData": {
+ "$ref": "PrivateData",
+ "description": "Private data for buyer. (hidden from seller)."
+ },
+ "dbmAdvertiserIds": {
+ "description": "IDs of DBM advertisers permission to this proposal.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hasBuyerSignedOff": {
+ "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)",
+ "type": "boolean"
+ },
+ "hasSellerSignedOff": {
+ "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)",
+ "type": "boolean"
+ },
+ "inventorySource": {
+ "description": "What exchange will provide this inventory (readonly, except on create).",
+ "type": "string"
+ },
+ "isRenegotiating": {
+ "description": "True if the proposal is being renegotiated (readonly).",
+ "type": "boolean"
+ },
+ "isSetupComplete": {
+ "description": "True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#proposal",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#proposal\".",
+ "type": "string"
+ },
+ "labels": {
+ "description": "List of labels associated with the proposal. (readonly)",
+ "items": {
+ "$ref": "MarketplaceLabel"
+ },
+ "type": "array"
+ },
+ "lastUpdaterOrCommentorRole": {
+ "description": "The role of the last user that either updated the proposal or left a comment. (readonly)",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name for the proposal (updatable)",
+ "type": "string"
+ },
+ "negotiationId": {
+ "description": "Optional negotiation id if this proposal is a preferred deal proposal.",
+ "type": "string"
+ },
+ "originatorRole": {
+ "description": "Indicates whether the buyer/seller created the proposal.(readonly)",
+ "type": "string"
+ },
+ "privateAuctionId": {
+ "description": "Optional private auction id if this proposal is a private auction proposal.",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The unique id of the proposal. (readonly).",
+ "type": "string"
+ },
+ "proposalState": {
+ "description": "The current state of the proposal. (readonly)",
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "The revision number for the proposal (readonly).",
+ "format": "int64",
+ "type": "string"
+ },
+ "revisionTimeMs": {
+ "description": "The time (ms since epoch) when the proposal was last revised (readonly).",
+ "format": "int64",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Reference to the seller on the proposal. (readonly, except on create)"
+ },
+ "sellerContacts": {
+ "description": "Optional contact information of the seller (buyer-readonly).",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PublisherProfileApiProto": {
+ "id": "PublisherProfileApiProto",
+ "properties": {
+ "audience": {
+ "description": "Publisher provided info on its audience.",
+ "type": "string"
+ },
+ "buyerPitchStatement": {
+ "description": "A pitch statement for the buyer",
+ "type": "string"
+ },
+ "directContact": {
+ "description": "Direct contact for the publisher profile.",
+ "type": "string"
+ },
+ "exchange": {
+ "description": "Exchange where this publisher profile is from. E.g. AdX, Rubicon etc...",
+ "type": "string"
+ },
+ "forecastInventory": {
+ "type": "string"
+ },
+ "googlePlusLink": {
+ "description": "Link to publisher's Google+ page.",
+ "type": "string"
+ },
+ "isParent": {
+ "description": "True, if this is the parent profile, which represents all domains owned by the publisher.",
+ "type": "boolean"
+ },
+ "isPublished": {
+ "description": "True, if this profile is published. Deprecated for state.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#publisherProfileApiProto",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
+ "type": "string"
+ },
+ "logoUrl": {
+ "description": "The url to the logo for the publisher.",
+ "type": "string"
+ },
+ "mediaKitLink": {
+ "description": "The url for additional marketing and sales materials.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "overview": {
+ "description": "Publisher provided overview.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "programmaticContact": {
+ "description": "Programmatic contact for the publisher profile.",
+ "type": "string"
+ },
+ "publisherAppIds": {
+ "description": "The list of app IDs represented in this publisher profile. Empty if this is a parent profile. Deprecated in favor of publisher_app.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "publisherApps": {
+ "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.",
+ "items": {
+ "$ref": "MobileApplication"
+ },
+ "type": "array"
+ },
+ "publisherDomains": {
+ "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "publisherProfileId": {
+ "description": "Unique Id for publisher profile.",
+ "type": "string"
+ },
+ "publisherProvidedForecast": {
+ "$ref": "PublisherProvidedForecast",
+ "description": "Publisher provided forecasting information."
+ },
+ "rateCardInfoLink": {
+ "description": "Link to publisher rate card",
+ "type": "string"
+ },
+ "samplePageLink": {
+ "description": "Link for a sample content page.",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Seller of the publisher profile."
+ },
+ "state": {
+ "description": "State of the publisher profile.",
+ "type": "string"
+ },
+ "topHeadlines": {
+ "description": "Publisher provided key metrics and rankings.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known proposal revision number.",
- "format": "int64"
+ "PublisherProvidedForecast": {
+ "description": "This message carries publisher provided forecasting information.",
+ "id": "PublisherProvidedForecast",
+ "properties": {
+ "dimensions": {
+ "description": "Publisher provided dimensions. E.g. geo, sizes etc...",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "weeklyImpressions": {
+ "description": "Publisher provided weekly impressions.",
+ "format": "int64",
+ "type": "string"
+ },
+ "weeklyUniques": {
+ "description": "Publisher provided weekly uniques.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "DeleteOrderDealsResponse": {
- "id": "DeleteOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals deleted (in the same proposal as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the proposal.",
- "format": "int64"
- }
- }
- },
- "DeliveryControl": {
- "id": "DeliveryControl",
- "type": "object",
- "properties": {
- "creativeBlockingLevel": {
- "type": "string"
- },
- "deliveryRateType": {
- "type": "string"
- },
- "frequencyCaps": {
- "type": "array",
- "items": {
- "$ref": "DeliveryControlFrequencyCap"
- }
- }
- }
- },
- "DeliveryControlFrequencyCap": {
- "id": "DeliveryControlFrequencyCap",
- "type": "object",
- "properties": {
- "maxImpressions": {
- "type": "integer",
- "format": "int32"
- },
- "numTimeUnits": {
- "type": "integer",
- "format": "int32"
- },
- "timeUnitType": {
- "type": "string"
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}",
- "properties": {
- "dimensionType": {
- "type": "string"
- },
- "dimensionValues": {
- "type": "array",
- "items": {
- "$ref": "DimensionDimensionValue"
- }
- }
- }
- },
- "DimensionDimensionValue": {
- "id": "DimensionDimensionValue",
- "type": "object",
- "description": "Value of the dimension.",
- "properties": {
- "id": {
- "type": "integer",
- "description": "Id of the dimension.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids."
- },
- "percentage": {
- "type": "integer",
- "description": "Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.",
- "format": "int32"
- }
- }
- },
- "EditAllOrderDealsRequest": {
- "id": "EditAllOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposal": {
- "$ref": "Proposal",
- "description": "If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction."
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known revision number for the proposal.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "EditAllOrderDealsResponse": {
- "id": "EditAllOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of all deals in the proposal after edit.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The latest revision number after the update has been applied.",
- "format": "int64"
- }
- }
- },
- "GetOffersResponse": {
- "id": "GetOffersResponse",
- "type": "object",
- "properties": {
- "products": {
- "type": "array",
- "description": "The returned list of products.",
- "items": {
- "$ref": "Product"
- }
- }
- }
- },
- "GetOrderDealsResponse": {
- "id": "GetOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals for the proposal",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- }
- }
- },
- "GetOrderNotesResponse": {
- "id": "GetOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "GetOrdersResponse": {
- "id": "GetOrdersResponse",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of matching proposals.",
- "items": {
- "$ref": "Proposal"
- }
- }
- }
- },
- "GetPublisherProfilesByAccountIdResponse": {
- "id": "GetPublisherProfilesByAccountIdResponse",
- "type": "object",
- "properties": {
- "profiles": {
- "type": "array",
- "description": "Profiles for the requested publisher",
- "items": {
- "$ref": "PublisherProfileApiProto"
- }
- }
- }
- },
- "MarketplaceDeal": {
- "id": "MarketplaceDeal",
- "type": "object",
- "description": "A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
- "properties": {
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Buyer private data (hidden from seller)."
- },
- "creationTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) of the deal creation. (readonly)",
- "format": "int64"
- },
- "creativePreApprovalPolicy": {
- "type": "string",
- "description": "Specifies the creative pre-approval policy (buyer-readonly)"
- },
- "creativeSafeFrameCompatibility": {
- "type": "string",
- "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)"
- },
- "dealId": {
- "type": "string",
- "description": "A unique deal-id for the deal (readonly)."
- },
- "dealServingMetadata": {
- "$ref": "DealServingMetadata",
- "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)"
- },
- "deliveryControl": {
- "$ref": "DeliveryControl",
- "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
- },
- "externalDealId": {
- "type": "string",
- "description": "The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)"
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "inventoryDescription": {
- "type": "string",
- "description": "Description for the deal terms. (buyer-readonly)"
- },
- "isRfpTemplate": {
- "type": "boolean",
- "description": "Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products."
- },
- "isSetupComplete": {
- "type": "boolean",
- "description": "True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
- "default": "adexchangebuyer#marketplaceDeal"
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
- "format": "int64"
- },
- "makegoodRequestedReason": {
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The name of the deal. (updatable)"
- },
- "productId": {
- "type": "string",
- "description": "The product-id from which this deal was created. (readonly, except on create)"
- },
- "productRevisionNumber": {
- "type": "string",
- "description": "The revision number of the product that the deal was created from (readonly, except on create)",
- "format": "int64"
- },
- "programmaticCreativeSource": {
- "type": "string",
- "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)"
- },
- "proposalId": {
- "type": "string"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional Seller contact information for the deal (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "sharedTargetings": {
- "type": "array",
- "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal. (updatable)"
- },
- "webPropertyCode": {
- "type": "string"
- }
- }
- },
- "MarketplaceDealParty": {
- "id": "MarketplaceDealParty",
- "type": "object",
- "properties": {
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party."
- },
- "seller": {
- "$ref": "Seller",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party."
- }
- }
- },
- "MarketplaceLabel": {
- "id": "MarketplaceLabel",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The accountId of the party that created the label."
- },
- "createTimeMs": {
- "type": "string",
- "description": "The creation time (in ms since epoch) for the label.",
- "format": "int64"
- },
- "deprecatedMarketplaceDealParty": {
- "$ref": "MarketplaceDealParty",
- "description": "Information about the party that created the label."
- },
- "label": {
- "type": "string",
- "description": "The label to use."
- }
- }
- },
- "MarketplaceNote": {
- "id": "MarketplaceNote",
- "type": "object",
- "description": "A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.",
- "properties": {
- "creatorRole": {
- "type": "string",
- "description": "The role of the person (buyer/seller) creating the note. (readonly)"
- },
- "dealId": {
- "type": "string",
- "description": "Notes can optionally be associated with a deal. (readonly, except on create)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceNote\".",
- "default": "adexchangebuyer#marketplaceNote"
- },
- "note": {
- "type": "string",
- "description": "The actual note to attach. (readonly, except on create)"
- },
- "noteId": {
- "type": "string",
- "description": "The unique id for the note. (readonly)"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId that a note is attached to. (readonly)"
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "If the note is associated with a proposal revision number, then store that here. (readonly, except on create)",
- "format": "int64"
- },
- "timestampMs": {
- "type": "string",
- "description": "The timestamp (ms since epoch) that this note was created. (readonly)",
- "format": "int64"
- }
- }
- },
- "MobileApplication": {
- "id": "MobileApplication",
- "type": "object",
- "properties": {
- "appStore": {
- "type": "string"
- },
- "externalAppId": {
- "type": "string"
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
- },
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
+ "Seller": {
+ "id": "Seller",
+ "properties": {
+ "accountId": {
+ "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.",
+ "type": "string"
+ },
+ "subAccountId": {
+ "description": "Optional sub-account id for the seller.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
- }
- }
- },
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
- },
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "maximumQps": {
- "type": "string",
- "description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
- "format": "int64"
- },
- "minimumViewabilityDecile": {
- "type": "integer",
- "description": "Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.",
- "format": "int32"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
+ "SharedTargeting": {
+ "id": "SharedTargeting",
+ "properties": {
+ "exclusions": {
+ "description": "The list of values to exclude from targeting. Each value is AND'd together.",
+ "items": {
+ "$ref": "TargetingValue"
+ },
+ "type": "array"
+ },
+ "inclusions": {
+ "description": "The list of value to include as part of the targeting. Each value is OR'd together.",
+ "items": {
+ "$ref": "TargetingValue"
+ },
+ "type": "array"
+ },
+ "key": {
+ "description": "The key representing the shared targeting criterion.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
- },
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "userIdentifierDataRequired": {
- "type": "array",
- "description": "Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.",
- "items": {
- "type": "string"
- }
- },
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "videoPlayerSizes": {
- "type": "array",
- "description": "Video requests satisfying any of these player size constraints will match.",
- "items": {
- "type": "object",
- "properties": {
- "aspectRatio": {
- "type": "string",
- "description": "The type of aspect ratio. Leave this field blank to match all aspect ratios."
- },
- "minHeight": {
- "type": "string",
- "description": "The minimum player height in pixels. Leave this field blank to match any player height.",
- "format": "int64"
- },
- "minWidth": {
- "type": "string",
- "description": "The minimum player width in pixels. Leave this field blank to match any player width.",
- "format": "int64"
- }
- }
- }
- }
- }
- },
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "amountMicros": {
- "type": "number",
- "description": "The price value in micros.",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the price."
- },
- "expectedCpmMicros": {
- "type": "number",
- "description": "In case of CPD deals, the expected CPM in micros.",
- "format": "double"
- },
- "pricingType": {
- "type": "string",
- "description": "The pricing type for the deal/product."
- }
- }
- },
- "PricePerBuyer": {
- "id": "PricePerBuyer",
- "type": "object",
- "description": "Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.",
- "properties": {
- "auctionTier": {
- "type": "string",
- "description": "Optional access type for this buyer."
- },
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer that will get billed."
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer)."
- },
- "price": {
- "$ref": "Price",
- "description": "The specified price"
- }
- }
- },
- "PrivateData": {
- "id": "PrivateData",
- "type": "object",
- "properties": {
- "referenceId": {
- "type": "string"
- },
- "referencePayload": {
- "type": "string",
- "format": "byte"
- }
- }
- },
- "Product": {
- "id": "Product",
- "type": "object",
- "description": "A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
- "properties": {
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)"
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)"
- },
- "creationTimeMs": {
- "type": "string",
- "description": "Creation time in ms. since epoch (readonly)",
- "format": "int64"
- },
- "creatorContacts": {
- "type": "array",
- "description": "Optional contact information for the creator of this product. (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "creatorRole": {
- "type": "string",
- "description": "The role that created the offer. Set to BUYER for buyer initiated offers."
- },
- "deliveryControl": {
- "$ref": "DeliveryControl",
- "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
- "format": "int64"
- },
- "hasCreatorSignedOff": {
- "type": "boolean",
- "description": "If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false."
- },
- "inventorySource": {
- "type": "string",
- "description": "What exchange will provide this inventory (readonly, except on create)."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#product\".",
- "default": "adexchangebuyer#product"
- },
- "labels": {
- "type": "array",
- "description": "Optional List of labels for the product (optional, buyer-readonly).",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "Time of last update in ms. since epoch (readonly)",
- "format": "int64"
- },
- "legacyOfferId": {
- "type": "string",
- "description": "Optional legacy offer id if this offer is a preferred deal offer."
- },
- "marketplacePublisherProfileId": {
- "type": "string",
- "description": "Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself."
- },
- "name": {
- "type": "string",
- "description": "The name for this product as set by the seller. (buyer-readonly)"
- },
- "privateAuctionId": {
- "type": "string",
- "description": "Optional private auction id if this offer is a private auction offer."
- },
- "productId": {
- "type": "string",
- "description": "The unique id for the product (readonly)"
- },
- "publisherProfileId": {
- "type": "string",
- "description": "Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller."
- },
- "publisherProvidedForecast": {
- "$ref": "PublisherProvidedForecast",
- "description": "Publisher self-provided forecast information."
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number of the product. (readonly)",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Information about the seller that created this product (readonly, except on create)"
- },
- "sharedTargetings": {
- "type": "array",
- "description": "Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "state": {
- "type": "string",
- "description": "The state of the product. (buyer-readonly)"
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal (buyer-readonly)"
- },
- "webPropertyCode": {
- "type": "string",
- "description": "The web property code for the seller. This field is meant to be copied over as is when creating deals."
- }
- }
- },
- "Proposal": {
- "id": "Proposal",
- "type": "object",
- "description": "Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
- "properties": {
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer that will get billed for this proposal. (readonly)"
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer on the proposal. (readonly, except on create)"
- },
- "buyerContacts": {
- "type": "array",
- "description": "Optional contact information of the buyer. (seller-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Private data for buyer. (hidden from seller)."
- },
- "dbmAdvertiserIds": {
- "type": "array",
- "description": "IDs of DBM advertisers permission to this proposal.",
- "items": {
- "type": "string"
- }
- },
- "hasBuyerSignedOff": {
- "type": "boolean",
- "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)"
- },
- "hasSellerSignedOff": {
- "type": "boolean",
- "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)"
- },
- "inventorySource": {
- "type": "string",
- "description": "What exchange will provide this inventory (readonly, except on create)."
- },
- "isRenegotiating": {
- "type": "boolean",
- "description": "True if the proposal is being renegotiated (readonly)."
- },
- "isSetupComplete": {
- "type": "boolean",
- "description": "True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#proposal\".",
- "default": "adexchangebuyer#proposal"
- },
- "labels": {
- "type": "array",
- "description": "List of labels associated with the proposal. (readonly)",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdaterOrCommentorRole": {
- "type": "string",
- "description": "The role of the last user that either updated the proposal or left a comment. (readonly)"
- },
- "name": {
- "type": "string",
- "description": "The name for the proposal (updatable)"
- },
- "negotiationId": {
- "type": "string",
- "description": "Optional negotiation id if this proposal is a preferred deal proposal."
- },
- "originatorRole": {
- "type": "string",
- "description": "Indicates whether the buyer/seller created the proposal.(readonly)"
- },
- "privateAuctionId": {
- "type": "string",
- "description": "Optional private auction id if this proposal is a private auction proposal."
- },
- "proposalId": {
- "type": "string",
- "description": "The unique id of the proposal. (readonly)."
- },
- "proposalState": {
- "type": "string",
- "description": "The current state of the proposal. (readonly)"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number for the proposal (readonly).",
- "format": "int64"
- },
- "revisionTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the proposal was last revised (readonly).",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Reference to the seller on the proposal. (readonly, except on create)"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional contact information of the seller (buyer-readonly).",
- "items": {
- "$ref": "ContactInformation"
- }
- }
- }
- },
- "PublisherProfileApiProto": {
- "id": "PublisherProfileApiProto",
- "type": "object",
- "properties": {
- "audience": {
- "type": "string",
- "description": "Publisher provided info on its audience."
- },
- "buyerPitchStatement": {
- "type": "string",
- "description": "A pitch statement for the buyer"
- },
- "directContact": {
- "type": "string",
- "description": "Direct contact for the publisher profile."
- },
- "exchange": {
- "type": "string",
- "description": "Exchange where this publisher profile is from. E.g. AdX, Rubicon etc..."
- },
- "googlePlusLink": {
- "type": "string",
- "description": "Link to publisher's Google+ page."
- },
- "isParent": {
- "type": "boolean",
- "description": "True, if this is the parent profile, which represents all domains owned by the publisher."
- },
- "isPublished": {
- "type": "boolean",
- "description": "True, if this profile is published. Deprecated for state."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
- "default": "adexchangebuyer#publisherProfileApiProto"
- },
- "logoUrl": {
- "type": "string",
- "description": "The url to the logo for the publisher."
- },
- "mediaKitLink": {
- "type": "string",
- "description": "The url for additional marketing and sales materials."
- },
- "name": {
- "type": "string"
- },
- "overview": {
- "type": "string",
- "description": "Publisher provided overview."
- },
- "profileId": {
- "type": "integer",
- "description": "The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.",
- "format": "int32"
- },
- "programmaticContact": {
- "type": "string",
- "description": "Programmatic contact for the publisher profile."
- },
- "publisherAppIds": {
- "type": "array",
- "description": "The list of app IDs represented in this pubisher profile. Empty if this is a parent profile. Deprecated in favor of publisher_app.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "publisherApps": {
- "type": "array",
- "description": "The list of apps represented in this pubisher profile. Empty if this is a parent profile.",
- "items": {
- "$ref": "MobileApplication"
- }
- },
- "publisherDomains": {
- "type": "array",
- "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
- "items": {
- "type": "string"
- }
+ "TargetingValue": {
+ "id": "TargetingValue",
+ "properties": {
+ "creativeSizeValue": {
+ "$ref": "TargetingValueCreativeSize",
+ "description": "The creative size value to exclude/include."
+ },
+ "dayPartTargetingValue": {
+ "$ref": "TargetingValueDayPartTargeting",
+ "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
+ },
+ "demogAgeCriteriaValue": {
+ "$ref": "TargetingValueDemogAgeCriteria"
+ },
+ "demogGenderCriteriaValue": {
+ "$ref": "TargetingValueDemogGenderCriteria"
+ },
+ "longValue": {
+ "description": "The long value to exclude/include.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestPlatformTargetingValue": {
+ "$ref": "TargetingValueRequestPlatformTargeting"
+ },
+ "stringValue": {
+ "description": "The string value to exclude/include.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "publisherProfileId": {
- "type": "string",
- "description": "Unique Id for publisher profile."
+ "TargetingValueCreativeSize": {
+ "description": "Next Id: 7",
+ "id": "TargetingValueCreativeSize",
+ "properties": {
+ "allowedFormats": {
+ "description": "The formats allowed by the publisher.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "companionSizes": {
+ "description": "For video size type, the list of companion sizes.",
+ "items": {
+ "$ref": "TargetingValueSize"
+ },
+ "type": "array"
+ },
+ "creativeSizeType": {
+ "description": "The Creative size type.",
+ "type": "string"
+ },
+ "nativeTemplate": {
+ "description": "The native template for native ad.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "TargetingValueSize",
+ "description": "For regular or video creative size type, specifies the size of the creative."
+ },
+ "skippableAdType": {
+ "description": "The skippable ad type for video size.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "publisherProvidedForecast": {
- "$ref": "PublisherProvidedForecast",
- "description": "Publisher provided forecasting information."
+ "TargetingValueDayPartTargeting": {
+ "id": "TargetingValueDayPartTargeting",
+ "properties": {
+ "dayParts": {
+ "items": {
+ "$ref": "TargetingValueDayPartTargetingDayPart"
+ },
+ "type": "array"
+ },
+ "timeZoneType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "rateCardInfoLink": {
- "type": "string",
- "description": "Link to publisher rate card"
+ "TargetingValueDayPartTargetingDayPart": {
+ "id": "TargetingValueDayPartTargetingDayPart",
+ "properties": {
+ "dayOfWeek": {
+ "type": "string"
+ },
+ "endHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "endMinute": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startMinute": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "samplePageLink": {
- "type": "string",
- "description": "Link for a sample content page."
+ "TargetingValueDemogAgeCriteria": {
+ "id": "TargetingValueDemogAgeCriteria",
+ "properties": {
+ "demogAgeCriteriaIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "seller": {
- "$ref": "Seller",
- "description": "Seller of the publisher profile."
+ "TargetingValueDemogGenderCriteria": {
+ "id": "TargetingValueDemogGenderCriteria",
+ "properties": {
+ "demogGenderCriteriaIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "state": {
- "type": "string",
- "description": "State of the publisher profile."
+ "TargetingValueRequestPlatformTargeting": {
+ "id": "TargetingValueRequestPlatformTargeting",
+ "properties": {
+ "requestPlatforms": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "topHeadlines": {
- "type": "array",
- "description": "Publisher provided key metrics and rankings.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "PublisherProvidedForecast": {
- "id": "PublisherProvidedForecast",
- "type": "object",
- "description": "This message carries publisher provided forecasting information.",
- "properties": {
- "dimensions": {
- "type": "array",
- "description": "Publisher provided dimensions. E.g. geo, sizes etc...",
- "items": {
- "$ref": "Dimension"
- }
- },
- "weeklyImpressions": {
- "type": "string",
- "description": "Publisher provided weekly impressions.",
- "format": "int64"
- },
- "weeklyUniques": {
- "type": "string",
- "description": "Publisher provided weekly uniques.",
- "format": "int64"
- }
- }
- },
- "Seller": {
- "id": "Seller",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product."
- },
- "subAccountId": {
- "type": "string",
- "description": "Optional sub-account id for the seller."
- }
- }
- },
- "SharedTargeting": {
- "id": "SharedTargeting",
- "type": "object",
- "properties": {
- "exclusions": {
- "type": "array",
- "description": "The list of values to exclude from targeting. Each value is AND'd together.",
- "items": {
- "$ref": "TargetingValue"
- }
- },
- "inclusions": {
- "type": "array",
- "description": "The list of value to include as part of the targeting. Each value is OR'd together.",
- "items": {
- "$ref": "TargetingValue"
- }
+ "TargetingValueSize": {
+ "id": "TargetingValueSize",
+ "properties": {
+ "height": {
+ "description": "The height of the creative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "The width of the creative.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "key": {
- "type": "string",
- "description": "The key representing the shared targeting criterion."
- }
- }
- },
- "TargetingValue": {
- "id": "TargetingValue",
- "type": "object",
- "properties": {
- "creativeSizeValue": {
- "$ref": "TargetingValueCreativeSize",
- "description": "The creative size value to exclude/include."
- },
- "dayPartTargetingValue": {
- "$ref": "TargetingValueDayPartTargeting",
- "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
- },
- "demogAgeCriteriaValue": {
- "$ref": "TargetingValueDemogAgeCriteria"
- },
- "demogGenderCriteriaValue": {
- "$ref": "TargetingValueDemogGenderCriteria"
- },
- "longValue": {
- "type": "string",
- "description": "The long value to exclude/include.",
- "format": "int64"
- },
- "requestPlatformTargetingValue": {
- "$ref": "TargetingValueRequestPlatformTargeting"
- },
- "stringValue": {
- "type": "string",
- "description": "The string value to exclude/include."
- }
- }
- },
- "TargetingValueCreativeSize": {
- "id": "TargetingValueCreativeSize",
- "type": "object",
- "description": "Next Id: 7",
- "properties": {
- "allowedFormats": {
- "type": "array",
- "description": "The formats allowed by the publisher.",
- "items": {
- "type": "string"
- }
- },
- "companionSizes": {
- "type": "array",
- "description": "For video size type, the list of companion sizes.",
- "items": {
- "$ref": "TargetingValueSize"
- }
- },
- "creativeSizeType": {
- "type": "string",
- "description": "The Creative size type."
- },
- "nativeTemplate": {
- "type": "string",
- "description": "The native template for native ad."
- },
- "size": {
- "$ref": "TargetingValueSize",
- "description": "For regular or video creative size type, specifies the size of the creative."
- },
- "skippableAdType": {
- "type": "string",
- "description": "The skippable ad type for video size."
- }
- }
- },
- "TargetingValueDayPartTargeting": {
- "id": "TargetingValueDayPartTargeting",
- "type": "object",
- "properties": {
- "dayParts": {
- "type": "array",
- "items": {
- "$ref": "TargetingValueDayPartTargetingDayPart"
- }
- },
- "timeZoneType": {
- "type": "string"
- }
- }
- },
- "TargetingValueDayPartTargetingDayPart": {
- "id": "TargetingValueDayPartTargetingDayPart",
- "type": "object",
- "properties": {
- "dayOfWeek": {
- "type": "string"
- },
- "endHour": {
- "type": "integer",
- "format": "int32"
- },
- "endMinute": {
- "type": "integer",
- "format": "int32"
- },
- "startHour": {
- "type": "integer",
- "format": "int32"
- },
- "startMinute": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "TargetingValueDemogAgeCriteria": {
- "id": "TargetingValueDemogAgeCriteria",
- "type": "object",
- "properties": {
- "demogAgeCriteriaIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetingValueDemogGenderCriteria": {
- "id": "TargetingValueDemogGenderCriteria",
- "type": "object",
- "properties": {
- "demogGenderCriteriaIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetingValueRequestPlatformTargeting": {
- "id": "TargetingValueRequestPlatformTargeting",
- "type": "object",
- "properties": {
- "requestPlatforms": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetingValueSize": {
- "id": "TargetingValueSize",
- "type": "object",
- "properties": {
- "height": {
- "type": "integer",
- "description": "The height of the creative.",
- "format": "int32"
- },
- "width": {
- "type": "integer",
- "description": "The width of the creative.",
- "format": "int32"
- }
- }
- },
- "UpdatePrivateAuctionProposalRequest": {
- "id": "UpdatePrivateAuctionProposalRequest",
- "type": "object",
- "properties": {
- "externalDealId": {
- "type": "string",
- "description": "The externalDealId of the deal to be updated."
- },
- "note": {
- "$ref": "MarketplaceNote",
- "description": "Optional note to be added."
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The current revision number of the proposal to be updated.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action on the private auction proposal."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "confirmUnsafeAccountChange": {
- "type": "boolean",
- "description": "Confirmation for erasing bidder and cookie matching urls.",
- "location": "query"
- },
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "confirmUnsafeAccountChange": {
- "type": "boolean",
- "description": "Confirmation for erasing bidder and cookie matching urls.",
- "location": "query"
- },
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "addDeal": {
- "id": "adexchangebuyer.creatives.addDeal",
- "path": "creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}",
- "httpMethod": "POST",
- "description": "Add a deal id association for the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "The id of the deal id to associate with this creative.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId",
- "dealId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "dealsStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given deals status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on deals.",
- "Creatives which have been conditionally approved for serving on deals.",
- "Creatives which have been disapproved for serving on deals.",
- "Creatives whose deals status is not yet checked."
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "openAuctionStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given open auction status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on the open auction.",
- "Creatives which have been conditionally approved for serving on the open auction.",
- "Creatives which have been disapproved for serving on the open auction.",
- "Creatives whose open auction status is not yet checked."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "listDeals": {
- "id": "adexchangebuyer.creatives.listDeals",
- "path": "creatives/{accountId}/{buyerCreativeId}/listDeals",
- "httpMethod": "GET",
- "description": "Lists the external deal ids associated with the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "CreativeDealIds"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "removeDeal": {
- "id": "adexchangebuyer.creatives.removeDeal",
- "path": "creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}",
- "httpMethod": "POST",
- "description": "Remove a deal id associated with the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "The id of the deal id to disassociate with this creative.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId",
- "dealId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacedeals": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.marketplacedeals.delete",
- "path": "proposals/{proposalId}/deals/delete",
- "httpMethod": "POST",
- "description": "Delete the specified deals from the proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to delete deals from.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "DeleteOrderDealsRequest"
- },
- "response": {
- "$ref": "DeleteOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.marketplacedeals.insert",
- "path": "proposals/{proposalId}/deals/insert",
- "httpMethod": "POST",
- "description": "Add new deals for the specified proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "proposalId for which deals need to be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "AddOrderDealsRequest"
- },
- "response": {
- "$ref": "AddOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacedeals.list",
- "path": "proposals/{proposalId}/deals",
- "httpMethod": "GET",
- "description": "List all the deals for a given proposal",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific deals.",
- "location": "query"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "GetOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.marketplacedeals.update",
- "path": "proposals/{proposalId}/deals/update",
- "httpMethod": "POST",
- "description": "Replaces all the deals in the proposal with the passed in deals",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to edit deals on.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "EditAllOrderDealsRequest"
- },
- "response": {
- "$ref": "EditAllOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacenotes": {
- "methods": {
- "insert": {
- "id": "adexchangebuyer.marketplacenotes.insert",
- "path": "proposals/{proposalId}/notes/insert",
- "httpMethod": "POST",
- "description": "Add notes to the proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to add notes for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "AddOrderNotesRequest"
- },
- "response": {
- "$ref": "AddOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacenotes.list",
- "path": "proposals/{proposalId}/notes",
- "httpMethod": "GET",
- "description": "Get all the notes associated with a proposal",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific notes. To search the text contents of notes, please use syntax like \"WHERE note.note = \"foo\" or \"WHERE note.note LIKE \"%bar%\"",
- "location": "query"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "GetOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplaceprivateauction": {
- "methods": {
- "updateproposal": {
- "id": "adexchangebuyer.marketplaceprivateauction.updateproposal",
- "path": "privateauction/{privateAuctionId}/updateproposal",
- "httpMethod": "POST",
- "description": "Update a given private auction proposal",
- "parameters": {
- "privateAuctionId": {
- "type": "string",
- "description": "The private auction id to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "privateAuctionId"
- ],
- "request": {
- "$ref": "UpdatePrivateAuctionProposalRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.products.get",
- "path": "products/{productId}",
- "httpMethod": "GET",
- "description": "Gets the requested product by id.",
- "parameters": {
- "productId": {
- "type": "string",
- "description": "The id for the product to get the head revision for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "productId"
- ],
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.products.search",
- "path": "products/search",
- "httpMethod": "GET",
- "description": "Gets the requested product.",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "The pql query used to query for products.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOffersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "proposals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.proposals.get",
- "path": "proposals/{proposalId}",
- "httpMethod": "GET",
- "description": "Get a proposal given its id",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "Id of the proposal to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.proposals.insert",
- "path": "proposals/insert",
- "httpMethod": "POST",
- "description": "Create the given list of proposals",
- "request": {
- "$ref": "CreateOrdersRequest"
- },
- "response": {
- "$ref": "CreateOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.proposals.patch",
- "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PATCH",
- "description": "Update the given proposal. This method supports patch semantics.",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "proposeAndAccept",
- "unknownAction",
- "updateNonTerms"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "Proposal"
- },
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.proposals.search",
- "path": "proposals/search",
- "httpMethod": "GET",
- "description": "Search for proposals using pql query",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific proposals.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "setupcomplete": {
- "id": "adexchangebuyer.proposals.setupcomplete",
- "path": "proposals/{proposalId}/setupcomplete",
- "httpMethod": "POST",
- "description": "Update the given proposal to indicate that setup has been completed.",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id for which the setup is complete",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.proposals.update",
- "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PUT",
- "description": "Update the given proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "proposeAndAccept",
- "unknownAction",
- "updateNonTerms"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "Proposal"
- },
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "UpdatePrivateAuctionProposalRequest": {
+ "id": "UpdatePrivateAuctionProposalRequest",
+ "properties": {
+ "externalDealId": {
+ "description": "The externalDealId of the deal to be updated.",
+ "type": "string"
+ },
+ "note": {
+ "$ref": "MarketplaceNote",
+ "description": "Optional note to be added."
+ },
+ "proposalRevisionNumber": {
+ "description": "The current revision number of the proposal to be updated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action on the private auction proposal.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "pubprofiles": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.pubprofiles.list",
- "path": "publisher/{accountId}/profiles",
- "httpMethod": "GET",
- "description": "Gets the requested publisher profile(s) by publisher accountId.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The accountId of the publisher to get profiles for.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "GetPublisherProfilesByAccountIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adexchangebuyer/v1.4/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.4"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json
index 6b056d98f4c..9a2942e7802 100644
--- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json
+++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json
@@ -2568,7 +2568,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://adexchangebuyer.googleapis.com/",
"schemas": {
"AbsoluteDateRange": {
@@ -4404,7 +4404,9 @@
"DAY",
"WEEK",
"MONTH",
- "LIFETIME"
+ "LIFETIME",
+ "POD",
+ "STREAM"
],
"enumDescriptions": [
"A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.",
@@ -4413,7 +4415,9 @@
"Day",
"Week",
"Month",
- "Lifetime"
+ "Lifetime",
+ "Pod",
+ "Stream"
],
"type": "string"
}
diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json
index 315a252fef2..c3c4e17ec17 100644
--- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json
@@ -1,453 +1,453 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.datatransfer": {
- "description": "View and manage data transfers between users in your organization"
- },
- "https://www.googleapis.com/auth/admin.datatransfer.readonly": {
- "description": "View data transfers between users in your organization"
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.datatransfer": {
+ "description": "View and manage data transfers between users in your organization"
+ },
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly": {
+ "description": "View data transfers between users in your organization"
}
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://admin.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "DataTransfer",
+ "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
+ "discoveryVersion": "v1",
+ "documentationLink": "http://developers.google.com/admin-sdk/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "admin:datatransfer_v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "basePath": "",
- "baseUrl": "https://admin.googleapis.com/",
- "batchPath": "batch",
- "canonicalName": "DataTransfer",
- "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
- "discoveryVersion": "v1",
- "documentationLink": "http://developers.google.com/admin-sdk/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
- "id": "admin:datatransfer_v1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
- "name": "admin",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "applications": {
+ "methods": {
+ "get": {
+ "description": "Retrieves information about an application for the given application ID.",
+ "flatPath": "admin/datatransfer/v1/applications/{applicationId}",
+ "httpMethod": "GET",
+ "id": "datatransfer.applications.get",
+ "parameterOrder": [
+ "applicationId"
+ ],
+ "parameters": {
+ "applicationId": {
+ "description": "ID of the application resource to be retrieved.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/datatransfer/v1/applications/{applicationId}",
+ "response": {
+ "$ref": "Application"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
},
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
+ "list": {
+ "description": "Lists the applications available for data transfer for a customer.",
+ "flatPath": "admin/datatransfer/v1/applications",
+ "httpMethod": "GET",
+ "id": "datatransfer.applications.list",
+ "parameterOrder": [],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the Google Workspace account.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "admin/datatransfer/v1/applications",
+ "response": {
+ "$ref": "ApplicationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ }
+ }
+ },
+ "transfers": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a data transfer request by its resource ID.",
+ "flatPath": "admin/datatransfer/v1/transfers/{dataTransferId}",
+ "httpMethod": "GET",
+ "id": "datatransfer.transfers.get",
+ "parameterOrder": [
+ "dataTransferId"
+ ],
+ "parameters": {
+ "dataTransferId": {
+ "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/datatransfer/v1/transfers/{dataTransferId}",
+ "response": {
+ "$ref": "DataTransfer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
+ "insert": {
+ "description": "Inserts a data transfer request.",
+ "flatPath": "admin/datatransfer/v1/transfers",
+ "httpMethod": "POST",
+ "id": "datatransfer.transfers.insert",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "admin/datatransfer/v1/transfers",
+ "request": {
+ "$ref": "DataTransfer"
+ },
+ "response": {
+ "$ref": "DataTransfer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer"
+ ]
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
+ "list": {
+ "description": "Lists the transfers for a customer by source user, destination user, or status.",
+ "flatPath": "admin/datatransfer/v1/transfers",
+ "httpMethod": "GET",
+ "id": "datatransfer.transfers.list",
+ "parameterOrder": [],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the Google Workspace account.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "newOwnerUserId": {
+ "description": "Destination user's profile ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "oldOwnerUserId": {
+ "description": "Source user's profile ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the transfer.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "admin/datatransfer/v1/transfers",
+ "response": {
+ "$ref": "DataTransfersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210511",
+ "rootUrl": "https://admin.googleapis.com/",
+ "schemas": {
+ "Application": {
+ "description": "Applications resources represent applications installed on the domain that support transferring ownership of user data.",
+ "id": "Application",
+ "properties": {
+ "etag": {
+ "description": "Etag of the resource.",
+ "type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
+ "id": {
+ "description": "The application's ID.",
+ "format": "int64",
+ "type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
+ "kind": {
+ "default": "admin#datatransfer#ApplicationResource",
+ "description": "Identifies the resource as a DataTransfer Application Resource.",
+ "type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
+ "name": {
+ "description": "The application's name.",
+ "type": "string"
},
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
+ "transferParams": {
+ "description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred.",
+ "items": {
+ "$ref": "ApplicationTransferParam"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ApplicationDataTransfer": {
+ "description": "Template to map fields of ApplicationDataTransfer resource.",
+ "id": "ApplicationDataTransfer",
+ "properties": {
+ "applicationId": {
+ "description": "The application's ID.",
+ "format": "int64",
+ "type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
+ "applicationTransferParams": {
+ "description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.",
+ "items": {
+ "$ref": "ApplicationTransferParam"
+ },
+ "type": "array"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "applicationTransferStatus": {
+ "description": "Current status of transfer for this application. (Read-only)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApplicationTransferParam": {
+ "description": "Template for application transfer parameters.",
+ "id": "ApplicationTransferParam",
+ "properties": {
+ "key": {
+ "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'",
+ "type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
+ "value": {
+ "description": "The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
+ "items": {
"type": "string"
+ },
+ "type": "array"
}
+ },
+ "type": "object"
},
- "protocol": "rest",
- "resources": {
+ "ApplicationsListResponse": {
+ "description": "Template for a collection of Applications.",
+ "id": "ApplicationsListResponse",
+ "properties": {
"applications": {
- "methods": {
- "get": {
- "description": "Retrieves information about an application for the given application ID.",
- "flatPath": "admin/datatransfer/v1/applications/{applicationId}",
- "httpMethod": "GET",
- "id": "datatransfer.applications.get",
- "parameterOrder": [
- "applicationId"
- ],
- "parameters": {
- "applicationId": {
- "description": "ID of the application resource to be retrieved.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/datatransfer/v1/applications/{applicationId}",
- "response": {
- "$ref": "Application"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "list": {
- "description": "Lists the applications available for data transfer for a customer.",
- "flatPath": "admin/datatransfer/v1/applications",
- "httpMethod": "GET",
- "id": "datatransfer.applications.list",
- "parameterOrder": [],
- "parameters": {
- "customerId": {
- "description": "Immutable ID of the Google Workspace account.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "Maximum number of results to return. Default is 100.",
- "format": "int32",
- "location": "query",
- "maximum": "500",
- "minimum": "1",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token to specify next page in the list.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "admin/datatransfer/v1/applications",
- "response": {
- "$ref": "ApplicationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
+ "description": "List of applications that support data transfer and are also installed for the customer.",
+ "items": {
+ "$ref": "Application"
+ },
+ "type": "array"
},
- "transfers": {
- "methods": {
- "get": {
- "description": "Retrieves a data transfer request by its resource ID.",
- "flatPath": "admin/datatransfer/v1/transfers/{dataTransferId}",
- "httpMethod": "GET",
- "id": "datatransfer.transfers.get",
- "parameterOrder": [
- "dataTransferId"
- ],
- "parameters": {
- "dataTransferId": {
- "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/datatransfer/v1/transfers/{dataTransferId}",
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "insert": {
- "description": "Inserts a data transfer request.",
- "flatPath": "admin/datatransfer/v1/transfers",
- "httpMethod": "POST",
- "id": "datatransfer.transfers.insert",
- "parameterOrder": [],
- "parameters": {},
- "path": "admin/datatransfer/v1/transfers",
- "request": {
- "$ref": "DataTransfer"
- },
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer"
- ]
- },
- "list": {
- "description": "Lists the transfers for a customer by source user, destination user, or status.",
- "flatPath": "admin/datatransfer/v1/transfers",
- "httpMethod": "GET",
- "id": "datatransfer.transfers.list",
- "parameterOrder": [],
- "parameters": {
- "customerId": {
- "description": "Immutable ID of the Google Workspace account.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "Maximum number of results to return. Default is 100.",
- "format": "int32",
- "location": "query",
- "maximum": "500",
- "minimum": "1",
- "type": "integer"
- },
- "newOwnerUserId": {
- "description": "Destination user's profile ID.",
- "location": "query",
- "type": "string"
- },
- "oldOwnerUserId": {
- "description": "Source user's profile ID.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Token to specify the next page in the list.",
- "location": "query",
- "type": "string"
- },
- "status": {
- "description": "Status of the transfer.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "admin/datatransfer/v1/transfers",
- "response": {
- "$ref": "DataTransfersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#applicationsList",
+ "description": "Identifies the resource as a collection of Applications.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token which will be used to specify next page in list API.",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "revision": "20210105",
- "rootUrl": "https://admin.googleapis.com/",
- "schemas": {
- "Application": {
- "description": "Applications resources represent applications installed on the domain that support transferring ownership of user data.",
- "id": "Application",
- "properties": {
- "etag": {
- "description": "Etag of the resource.",
- "type": "string"
- },
- "id": {
- "description": "The application's ID.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "default": "admin#datatransfer#ApplicationResource",
- "description": "Identifies the resource as a DataTransfer Application Resource.",
- "type": "string"
- },
- "name": {
- "description": "The application's name.",
- "type": "string"
- },
- "transferParams": {
- "description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred.",
- "items": {
- "$ref": "ApplicationTransferParam"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "DataTransfer": {
+ "description": "A Transfer resource represents the transfer of the ownership of user data between users.",
+ "id": "DataTransfer",
+ "properties": {
+ "applicationDataTransfers": {
+ "description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.",
+ "items": {
+ "$ref": "ApplicationDataTransfer"
+ },
+ "type": "array"
},
- "ApplicationDataTransfer": {
- "description": "Template to map fields of ApplicationDataTransfer resource.",
- "id": "ApplicationDataTransfer",
- "properties": {
- "applicationId": {
- "description": "The application's ID.",
- "format": "int64",
- "type": "string"
- },
- "applicationTransferParams": {
- "description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.",
- "items": {
- "$ref": "ApplicationTransferParam"
- },
- "type": "array"
- },
- "applicationTransferStatus": {
- "description": "Current status of transfer for this application. (Read-only)",
- "type": "string"
- }
- },
- "type": "object"
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "ApplicationTransferParam": {
- "description": "Template for application transfer parameters.",
- "id": "ApplicationTransferParam",
- "properties": {
- "key": {
- "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'",
- "type": "string"
- },
- "value": {
- "description": "The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "id": {
+ "description": "The transfer's ID (Read-only).",
+ "type": "string"
},
- "ApplicationsListResponse": {
- "description": "Template for a collection of Applications.",
- "id": "ApplicationsListResponse",
- "properties": {
- "applications": {
- "description": "List of applications that support data transfer and are also installed for the customer.",
- "items": {
- "$ref": "Application"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#datatransfer#applicationsList",
- "description": "Identifies the resource as a collection of Applications.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token which will be used to specify next page in list API.",
- "type": "string"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#datatransfer#DataTransfer",
+ "description": "Identifies the resource as a DataTransfer request.",
+ "type": "string"
},
- "DataTransfer": {
- "description": "A Transfer resource represents the transfer of the ownership of user data between users.",
- "id": "DataTransfer",
- "properties": {
- "applicationDataTransfers": {
- "description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.",
- "items": {
- "$ref": "ApplicationDataTransfer"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "id": {
- "description": "The transfer's ID (Read-only).",
- "type": "string"
- },
- "kind": {
- "default": "admin#datatransfer#DataTransfer",
- "description": "Identifies the resource as a DataTransfer request.",
- "type": "string"
- },
- "newOwnerUserId": {
- "description": "ID of the user to whom the data is being transferred.",
- "type": "string"
- },
- "oldOwnerUserId": {
- "description": "ID of the user whose data is being transferred.",
- "type": "string"
- },
- "overallTransferStatusCode": {
- "description": "Overall transfer status (Read-only).",
- "type": "string"
- },
- "requestTime": {
- "description": "The time at which the data transfer was requested (Read-only).",
- "format": "date-time",
- "type": "string"
- }
- },
- "type": "object"
+ "newOwnerUserId": {
+ "description": "ID of the user to whom the data is being transferred.",
+ "type": "string"
},
- "DataTransfersListResponse": {
- "description": "Template for a collection of DataTransfer resources.",
- "id": "DataTransfersListResponse",
- "properties": {
- "dataTransfers": {
- "description": "List of data transfer requests.",
- "items": {
- "$ref": "DataTransfer"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#datatransfer#dataTransfersList",
- "description": "Identifies the resource as a collection of data transfer requests.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token which will be used to specify next page in list API.",
- "type": "string"
- }
- },
- "type": "object"
+ "oldOwnerUserId": {
+ "description": "ID of the user whose data is being transferred.",
+ "type": "string"
+ },
+ "overallTransferStatusCode": {
+ "description": "Overall transfer status (Read-only).",
+ "type": "string"
+ },
+ "requestTime": {
+ "description": "The time at which the data transfer was requested (Read-only).",
+ "format": "date-time",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "",
- "title": "Admin SDK API",
- "version": "datatransfer_v1"
+ "DataTransfersListResponse": {
+ "description": "Template for a collection of DataTransfer resources.",
+ "id": "DataTransfersListResponse",
+ "properties": {
+ "dataTransfers": {
+ "description": "List of data transfer requests.",
+ "items": {
+ "$ref": "DataTransfer"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#dataTransfersList",
+ "description": "Identifies the resource as a collection of data transfer requests.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token which will be used to specify next page in list API.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Admin SDK API",
+ "version": "datatransfer_v1"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
index cadfa68f239..07e1d30a083 100644
--- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
@@ -1,7710 +1,7720 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.chrome.printers": {
- "description": "See, add, edit, and permanently delete the printers that your organization can use with Chrome"
- },
- "https://www.googleapis.com/auth/admin.chrome.printers.readonly": {
- "description": "See the printers that your organization can use with Chrome"
- },
- "https://www.googleapis.com/auth/admin.directory.customer": {
- "description": "View and manage customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.customer.readonly": {
- "description": "View customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
- "description": "View and manage your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
- "description": "View your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile": {
- "description": "View and manage your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
- "description": "Manage your mobile devices by performing administrative tasks"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
- "description": "View your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.domain": {
- "description": "View and manage the provisioning of domains for your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.domain.readonly": {
- "description": "View domains related to your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.group": {
- "description": "View and manage the provisioning of groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member": {
- "description": "View and manage group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
- "description": "View group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.readonly": {
- "description": "View groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit": {
- "description": "View and manage organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
- "description": "View organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.resource.calendar": {
- "description": "View and manage the provisioning of calendar resources on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly": {
- "description": "View calendar resources on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement": {
- "description": "Manage delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly": {
- "description": "View delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user": {
- "description": "View and manage the provisioning of users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias": {
- "description": "View and manage user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
- "description": "View user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.readonly": {
- "description": "See info about users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.security": {
- "description": "Manage data access permissions for users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema": {
- "description": "View and manage the provisioning of user schemas on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
- "description": "View user schemas on your domain"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "See, edit, configure, and delete your Google Cloud Platform data"
- }
- }
- }
- },
- "basePath": "",
- "baseUrl": "https://admin.googleapis.com/",
- "batchPath": "batch",
- "canonicalName": "directory",
- "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
- "discoveryVersion": "v1",
- "documentationLink": "http://developers.google.com/admin-sdk/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "admin:directory_v1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
- "name": "admin",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.chrome.printers": {
+ "description": "See, add, edit, and permanently delete the printers that your organization can use with Chrome"
},
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.chrome.printers.readonly": {
+ "description": "See the printers that your organization can use with Chrome"
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.customer": {
+ "description": "View and manage customer related information"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.customer.readonly": {
+ "description": "View customer related information"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
+ "description": "View and manage your Chrome OS devices' metadata"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
+ "description": "View your Chrome OS devices' metadata"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.device.mobile": {
+ "description": "View and manage your mobile devices' metadata"
},
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
+ "description": "Manage your mobile devices by performing administrative tasks"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
+ "description": "View your mobile devices' metadata"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.domain": {
+ "description": "View and manage the provisioning of domains for your customers"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly": {
+ "description": "View domains related to your customers"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group": {
+ "description": "View and manage the provisioning of groups on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.member": {
+ "description": "View and manage group subscriptions on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
+ "description": "View group subscriptions on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.readonly": {
+ "description": "View groups on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.orgunit": {
+ "description": "View and manage organization units on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
+ "description": "View organization units on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar": {
+ "description": "View and manage the provisioning of calendar resources on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly": {
+ "description": "View calendar resources on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement": {
+ "description": "Manage delegated admin roles for your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly": {
+ "description": "View delegated admin roles for your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user": {
+ "description": "View and manage the provisioning of users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.alias": {
+ "description": "View and manage user aliases on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
+ "description": "View user aliases on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.readonly": {
+ "description": "See info about users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.security": {
+ "description": "Manage data access permissions for users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.userschema": {
+ "description": "View and manage the provisioning of user schemas on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
+ "description": "View user schemas on your domain"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "See, edit, configure, and delete your Google Cloud Platform data"
}
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://admin.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "directory",
+ "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
+ "discoveryVersion": "v1",
+ "documentationLink": "http://developers.google.com/admin-sdk/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "admin:directory_v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "protocol": "rest",
- "resources": {
- "asps": {
- "methods": {
- "delete": {
- "description": "Delete an ASP issued by a user.",
- "flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
- "httpMethod": "DELETE",
- "id": "directory.asps.delete",
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "parameters": {
- "codeId": {
- "description": "The unique ID of the ASP to be deleted.",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "userKey": {
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/directory/v1/users/{userKey}/asps/{codeId}",
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "get": {
- "description": "Get information about an ASP issued by a user.",
- "flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
- "httpMethod": "GET",
- "id": "directory.asps.get",
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "parameters": {
- "codeId": {
- "description": "The unique ID of the ASP.",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "userKey": {
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/directory/v1/users/{userKey}/asps/{codeId}",
- "response": {
- "$ref": "Asp"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "description": "List the ASPs issued by a user.",
- "flatPath": "admin/directory/v1/users/{userKey}/asps",
- "httpMethod": "GET",
- "id": "directory.asps.list",
- "parameterOrder": [
- "userKey"
- ],
- "parameters": {
- "userKey": {
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/directory/v1/users/{userKey}/asps",
- "response": {
- "$ref": "Asps"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "asps": {
+ "methods": {
+ "delete": {
+ "description": "Delete an ASP issued by a user.",
+ "flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
+ "httpMethod": "DELETE",
+ "id": "directory.asps.delete",
+ "parameterOrder": [
+ "userKey",
+ "codeId"
+ ],
+ "parameters": {
+ "codeId": {
+ "description": "The unique ID of the ASP to be deleted.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "admin/directory/v1/users/{userKey}/asps/{codeId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
},
- "channels": {
- "methods": {
- "stop": {
- "description": "Stop watching resources through this channel.",
- "flatPath": "admin/directory_v1/channels/stop",
- "httpMethod": "POST",
- "id": "admin.channels.stop",
- "parameterOrder": [],
- "parameters": {},
- "path": "admin/directory_v1/channels/stop",
- "request": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
+ "get": {
+ "description": "Get information about an ASP issued by a user.",
+ "flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
+ "httpMethod": "GET",
+ "id": "directory.asps.get",
+ "parameterOrder": [
+ "userKey",
+ "codeId"
+ ],
+ "parameters": {
+ "codeId": {
+ "description": "The unique ID of the ASP.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "admin/directory/v1/users/{userKey}/asps/{codeId}",
+ "response": {
+ "$ref": "Asp"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
},
- "chromeosdevices": {
- "methods": {
- "action": {
- "description": "Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).",
- "flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action",
- "httpMethod": "POST",
- "id": "directory.chromeosdevices.action",
- "parameterOrder": [
+ "list": {
+ "description": "List the ASPs issued by a user.",
+ "flatPath": "admin/directory/v1/users/{userKey}/asps",
+ "httpMethod": "GET",
+ "id": "directory.asps.list",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/directory/v1/users/{userKey}/asps",
+ "response": {
+ "$ref": "Asps"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ }
+ }
+ },
+ "channels": {
+ "methods": {
+ "stop": {
+ "description": "Stop watching resources through this channel.",
+ "flatPath": "admin/directory_v1/channels/stop",
+ "httpMethod": "POST",
+ "id": "admin.channels.stop",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "admin/directory_v1/channels/stop",
+ "request": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias",
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "chromeosdevices": {
+ "methods": {
+ "action": {
+ "description": "Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).",
+ "flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action",
+ "httpMethod": "POST",
+ "id": "directory.chromeosdevices.action",
+ "parameterOrder": [
+ "customerId",
+ "resourceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action",
+ "request": {
+ "$ref": "ChromeOsDeviceAction"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a Chrome OS device's properties.",
+ "flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}",
+ "httpMethod": "GET",
+ "id": "directory.chromeosdevices.get",
+ "parameterOrder": [
+ "customerId",
+ "deviceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Determines whether the response contains the full list of properties or only a subset.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}",
+ "response": {
+ "$ref": "ChromeOsDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos",
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a paginated list of Chrome OS devices within an account.",
+ "flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos",
+ "httpMethod": "GET",
+ "id": "directory.chromeosdevices.list",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "100",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Device property to use for sorting results.",
+ "enum": [
+ "annotatedLocation",
+ "annotatedUser",
+ "lastSync",
+ "notes",
+ "serialNumber",
+ "status",
+ "supportEndDate"
+ ],
+ "enumDescriptions": [
+ "Chrome device location as annotated by the administrator.",
+ "Chromebook user as annotated by administrator.",
+ "The date and time the Chrome device was last synchronized with the policy settings in the Admin console.",
+ "Chrome device notes as annotated by the administrator.",
+ "The Chrome device serial number entered when the device was enabled.",
+ "Chrome device status. For more information, see the 312e3200 TPM 2.0: \"2.0\" -> 322e3000",
+ "type": "string"
+ },
+ "firmwareVersion": {
+ "description": "TPM firmware version.",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "TPM manufacturer code.",
+ "type": "string"
+ },
+ "specLevel": {
+ "description": "TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.",
+ "type": "string"
+ },
+ "tpmModel": {
+ "description": "TPM model number.",
+ "type": "string"
+ },
+ "vendorSpecific": {
+ "description": "Vendor-specific information such as Vendor ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "willAutoRenew": {
+ "description": "Determines if the device will auto renew its support after the support end date. This is a read-only property.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsDeviceAction": {
+ "id": "ChromeOsDeviceAction",
+ "properties": {
+ "action": {
+ "annotations": {
+ "required": [
+ "directory.chromeosdevices.action"
+ ]
+ },
+ "description": "Action to be taken on the Chrome OS device.",
+ "type": "string"
+ },
+ "deprovisionReason": {
+ "description": "Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsDevices": {
+ "id": "ChromeOsDevices",
+ "properties": {
+ "chromeosdevices": {
+ "description": "List of Chrome OS Device objects.",
+ "items": {
+ "$ref": "ChromeOsDevice"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#chromeosdevices",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsMoveDevicesToOu": {
+ "id": "ChromeOsMoveDevicesToOu",
+ "properties": {
+ "deviceIds": {
+ "annotations": {
+ "required": [
+ "directory.chromeosdevices.moveDevicesToOu"
+ ]
+ },
+ "description": "Chrome OS devices to be moved to OU",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreatePrinterRequest": {
+ "description": "Request for adding a new printer.",
+ "id": "CreatePrinterRequest",
+ "properties": {
+ "parent": {
+ "description": "Required. The name of the customer. Format: customers/{customer_id}",
+ "type": "string"
+ },
+ "printer": {
+ "$ref": "Printer",
+ "description": "Required. A printer to create. If you want to place the printer under particular OU then populate printer.org_unit_id filed. Otherwise the printer will be placed under root OU."
+ }
+ },
+ "type": "object"
+ },
+ "Customer": {
+ "id": "Customer",
+ "properties": {
+ "alternateEmail": {
+ "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain`",
+ "type": "string"
+ },
+ "customerCreationTime": {
+ "description": "The customer's creation time (Readonly)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "customerDomain": {
+ "description": "The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID for the customer's Google Workspace account. (Readonly)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#customer",
+ "description": "Identifies the resource as a customer. Value: `admin#directory#customer`",
+ "type": "string"
+ },
+ "language": {
+ "description": "The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.",
+ "type": "string"
+ },
+ "postalAddress": {
+ "$ref": "CustomerPostalAddress",
+ "description": "The customer's postal address information."
+ }
+ },
+ "type": "object"
+ },
+ "CustomerPostalAddress": {
+ "id": "CustomerPostalAddress",
+ "properties": {
+ "addressLine1": {
+ "description": "A customer's physical address. The address can be composed of one to three lines.",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "Address line 2 of the address.",
+ "type": "string"
+ },
+ "addressLine3": {
+ "description": "Address line 3 of the address.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "The customer contact's name.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Name of the locality. An example of a locality value is the city of `San Francisco`.",
+ "type": "string"
+ },
+ "organizationName": {
+ "description": "The company or company division name.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region. An example of a region value is `NY` for the state of New York.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectoryChromeosdevicesCommand": {
+ "description": "Information regarding a command that was issued to a device.",
+ "id": "DirectoryChromeosdevicesCommand",
+ "properties": {
+ "commandExpireTime": {
+ "description": "The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "commandId": {
+ "description": "Unique ID of a device command.",
+ "format": "int64",
+ "type": "string"
+ },
+ "commandResult": {
+ "$ref": "DirectoryChromeosdevicesCommandResult",
+ "description": "The result of the command execution."
+ },
+ "issueTime": {
+ "description": "The timestamp when the command was issued by the admin.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "payload": {
+ "description": "The payload that the command specified, if any.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Indicates the command state.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "EXPIRED",
+ "CANCELLED",
+ "SENT_TO_CLIENT",
+ "ACKED_BY_CLIENT",
+ "EXECUTED_BY_CLIENT"
+ ],
+ "enumDescriptions": [
+ "The command status was unspecified.",
+ "An unexpired command not yet sent to the client.",
+ "The command didn't get executed by the client within the expected time.",
+ "The command is cancelled by admin while in PENDING.",
+ "The command has been sent to the client.",
+ "The client has responded that it received the command.",
+ "The client has (un)successfully executed the command."
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the command.",
+ "enum": [
+ "COMMAND_TYPE_UNSPECIFIED",
+ "REBOOT",
+ "TAKE_A_SCREENSHOT",
+ "SET_VOLUME",
+ "WIPE_USERS",
+ "REMOTE_POWERWASH"
+ ],
+ "enumDescriptions": [
+ "The command type was unspecified.",
+ "Reboot the device. Can only be issued to Kiosk and managed guest session devices.",
+ "Take a screenshot of the device. Only available if the device is in Kiosk Mode.",
+ "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
+ "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
+ "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectoryChromeosdevicesCommandResult": {
+ "description": "The result of executing a command.",
+ "id": "DirectoryChromeosdevicesCommandResult",
+ "properties": {
+ "errorMessage": {
+ "description": "The error message with a short explanation as to why the command failed. Only present if the command failed.",
+ "type": "string"
+ },
+ "executeTime": {
+ "description": "The time at which the command was executed or failed to execute.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "result": {
+ "description": "The result of the command.",
+ "enum": [
+ "COMMAND_RESULT_TYPE_UNSPECIFIED",
+ "IGNORED",
+ "FAILURE",
+ "SUCCESS"
+ ],
+ "enumDescriptions": [
+ "The command result was unspecified.",
+ "The command was ignored as obsolete.",
+ "The command could not be executed successfully.",
+ "The command was successfully executed."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectoryChromeosdevicesIssueCommandRequest": {
+ "description": "A request for issuing a command.",
+ "id": "DirectoryChromeosdevicesIssueCommandRequest",
+ "properties": {
+ "commandType": {
+ "description": "The type of command.",
+ "enum": [
+ "COMMAND_TYPE_UNSPECIFIED",
+ "REBOOT",
+ "TAKE_A_SCREENSHOT",
+ "SET_VOLUME",
+ "WIPE_USERS",
+ "REMOTE_POWERWASH"
+ ],
+ "enumDescriptions": [
+ "The command type was unspecified.",
+ "Reboot the device. Can only be issued to Kiosk and managed guest session devices.",
+ "Take a screenshot of the device. Only available if the device is in Kiosk Mode.",
+ "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
+ "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
+ "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!"
+ ],
+ "type": "string"
+ },
+ "payload": {
+ "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: - SET_VOLUME: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100].",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectoryChromeosdevicesIssueCommandResponse": {
+ "description": "A response for issuing a command.",
+ "id": "DirectoryChromeosdevicesIssueCommandResponse",
+ "properties": {
+ "commandId": {
+ "description": "The unique ID of the issued command, used to retrieve the command status.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainAlias": {
+ "id": "DomainAlias",
+ "properties": {
+ "creationTime": {
+ "description": "The creation time of the domain alias. (Read-only).",
+ "format": "int64",
+ "type": "string"
+ },
+ "domainAliasName": {
+ "description": "The domain alias name.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domainAlias",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "parentDomainName": {
+ "annotations": {
+ "required": [
+ "directory.domains.insert"
+ ]
+ },
+ "description": "The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.",
+ "type": "string"
+ },
+ "verified": {
+ "description": "Indicates the verification state of a domain alias. (Read-only)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DomainAliases": {
+ "id": "DomainAliases",
+ "properties": {
+ "domainAliases": {
+ "description": "List of domain alias objects.",
+ "items": {
+ "$ref": "DomainAlias"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domainAliases",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Domains": {
+ "id": "Domains",
+ "properties": {
+ "creationTime": {
+ "description": "Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).",
+ "format": "int64",
+ "type": "string"
+ },
+ "domainAliases": {
+ "description": "List of domain alias objects. (Read-only)",
+ "items": {
+ "$ref": "DomainAlias"
+ },
+ "type": "array"
+ },
+ "domainName": {
+ "annotations": {
+ "required": [
+ "directory.domains.insert"
+ ]
+ },
+ "description": "The domain name of the customer.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "isPrimary": {
+ "description": "Indicates if the domain is a primary domain (Read-only).",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#domain",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "verified": {
+ "description": "Indicates the verification state of a domain. (Read-only).",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Domains2": {
+ "id": "Domains2",
+ "properties": {
+ "domains": {
+ "description": "List of domain objects.",
+ "items": {
+ "$ref": "Domains"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domains",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FailureInfo": {
+ "description": "Info about failures",
+ "id": "FailureInfo",
+ "properties": {
+ "errorCode": {
+ "description": "Canonical code for why the update failed to apply.",
+ "enum": [
+ "OK",
+ "CANCELLED",
+ "UNKNOWN",
+ "INVALID_ARGUMENT",
+ "DEADLINE_EXCEEDED",
+ "NOT_FOUND",
+ "ALREADY_EXISTS",
+ "PERMISSION_DENIED",
+ "UNAUTHENTICATED",
+ "RESOURCE_EXHAUSTED",
+ "FAILED_PRECONDITION",
+ "ABORTED",
+ "OUT_OF_RANGE",
+ "UNIMPLEMENTED",
+ "INTERNAL",
+ "UNAVAILABLE",
+ "DATA_LOSS"
+ ],
+ "enumDescriptions": [
+ "Not an error; returned on success HTTP Mapping: 200 OK",
+ "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
+ "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
+ "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
+ "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
+ "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
+ "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
+ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
+ "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
+ "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
+ "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
+ "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
+ "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
+ "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
+ "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
+ "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
+ "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
+ ],
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Failure reason message.",
+ "type": "string"
+ },
+ "printer": {
+ "$ref": "Printer",
+ "description": "Failed printer."
+ },
+ "printerId": {
+ "description": "Id of a failed printer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Feature": {
+ "description": "JSON template for Feature object in Directory API.",
+ "id": "Feature",
+ "properties": {
+ "etags": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#resources#features#Feature",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "directory.resources.features.insert"
+ ]
+ },
+ "description": "The name of the feature.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FeatureInstance": {
+ "description": "JSON template for a feature instance.",
+ "id": "FeatureInstance",
+ "properties": {
+ "feature": {
+ "$ref": "Feature",
+ "description": "The feature that this is an instance of. A calendar resource may have multiple instances of a feature."
+ }
+ },
+ "type": "object"
+ },
+ "FeatureRename": {
+ "id": "FeatureRename",
+ "properties": {
+ "newName": {
+ "annotations": {
+ "required": [
+ "directory.resources.features.rename"
+ ]
+ },
+ "description": "New name of the feature.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Features": {
+ "description": "Public API: Resources.features",
+ "id": "Features",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "features": {
+ "description": "The Features in this page of results.",
+ "items": {
+ "$ref": "Feature"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#resources#features#featuresList",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Group": {
+ "description": "Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).",
+ "id": "Group",
+ "properties": {
+ "adminCreated": {
+ "description": "Value is `true` if this group was created by an administrator rather than a user.",
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "List of a group's alias email addresses.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.",
+ "type": "string"
+ },
+ "directMembersCount": {
+ "description": "The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "directory.groups.insert"
+ ]
+ },
+ "description": "The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#group",
+ "description": "The type of the API resource. For Groups resources, the value is `admin#directory#group`.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The group's display name.",
+ "type": "string"
+ },
+ "nonEditableAliases": {
+ "description": "List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Groups": {
+ "id": "Groups",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "groups": {
+ "description": "List of group objects.",
+ "items": {
+ "$ref": "Group"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#groups",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListPrinterModelsResponse": {
+ "description": "Response for listing allowed printer models.",
+ "id": "ListPrinterModelsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "printerModels": {
+ "description": "Printer models that are currently allowed to be configured for ChromeOs. Some printers may be added or removed over time.",
+ "items": {
+ "$ref": "PrinterModel"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPrintersResponse": {
+ "description": "Response for listing printers.",
+ "id": "ListPrintersResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "printers": {
+ "description": "List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was given in the request, then all printers will be returned.",
+ "items": {
+ "$ref": "Printer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Member": {
+ "description": "A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).",
+ "id": "Member",
+ "properties": {
+ "delivery_settings": {
+ "description": "Defines mail delivery preferences of member. This is only supported by create/update/get.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#member",
+ "description": "The type of the API resource. For Members resources, the value is `admin#directory#member`.",
+ "type": "string"
+ },
+ "role": {
+ "description": "The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of member (Immutable)",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of group member.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Members": {
+ "id": "Members",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#members",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "members": {
+ "description": "List of member objects.",
+ "items": {
+ "$ref": "Member"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MembersHasMember": {
+ "description": "JSON template for Has Member response in Directory API.",
+ "id": "MembersHasMember",
+ "properties": {
+ "isMember": {
+ "description": "Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.",
+ "readOnly": true,
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDevice": {
+ "description": "Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html).",
+ "id": "MobileDevice",
+ "properties": {
+ "adbStatus": {
+ "description": "Adb (USB debugging) enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "applications": {
+ "description": "The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.",
+ "items": {
+ "properties": {
+ "displayName": {
+ "description": "The application's display name. An example is `Browser`.",
+ "type": "string"
+ },
+ "packageName": {
+ "description": "The application's package name. An example is `com.android.browser`.",
+ "type": "string"
+ },
+ "permission": {
+ "description": "The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "versionCode": {
+ "description": "The application's version code. An example is `13`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "versionName": {
+ "description": "The application's version name. An example is `3.2-140714`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "basebandVersion": {
+ "description": "The device's baseband version.",
+ "type": "string"
+ },
+ "bootloaderVersion": {
+ "description": "Mobile Device Bootloader version (Read-only)",
+ "type": "string"
+ },
+ "brand": {
+ "description": "Mobile Device Brand (Read-only)",
+ "type": "string"
+ },
+ "buildNumber": {
+ "description": "The device's operating system build number.",
+ "type": "string"
+ },
+ "defaultLanguage": {
+ "description": "The default locale used on the device.",
+ "type": "string"
+ },
+ "developerOptionsStatus": {
+ "description": "Developer options enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "deviceCompromisedStatus": {
+ "description": "The compromised device status.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.",
+ "type": "string"
+ },
+ "devicePasswordStatus": {
+ "description": "DevicePasswordStatus (Read-only)",
+ "type": "string"
+ },
+ "email": {
+ "description": "List of owner's email addresses. If your application needs the current list of user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](/admin-sdk/directory/v1/guides/manage-users#get_user) method.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "encryptionStatus": {
+ "description": "Mobile Device Encryption Status (Read-only)",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "firstSync": {
+ "description": "Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "hardware": {
+ "description": "Mobile Device Hardware (Read-only)",
+ "type": "string"
+ },
+ "hardwareId": {
+ "description": "The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.",
+ "type": "string"
+ },
+ "imei": {
+ "description": "The device's IMEI number.",
+ "type": "string"
+ },
+ "kernelVersion": {
+ "description": "The device's kernel version.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#mobiledevice",
+ "description": "The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.",
+ "type": "string"
+ },
+ "lastSync": {
+ "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "managedAccountIsOnOwnerProfile": {
+ "description": "Boolean indicating if this account is on owner/primary profile or not.",
+ "type": "boolean"
+ },
+ "manufacturer": {
+ "description": "Mobile Device manufacturer (Read-only)",
+ "type": "string"
+ },
+ "meid": {
+ "description": "The device's MEID number.",
+ "type": "string"
+ },
+ "model": {
+ "description": "The mobile device's model name, for example Nexus S. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile=devices#update_mobile_device).",
+ "type": "string"
+ },
+ "name": {
+ "description": "List of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-users#get_user).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "networkOperator": {
+ "description": "Mobile Device mobile or network operator (if available) (Read-only)",
+ "type": "string"
+ },
+ "os": {
+ "description": "The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).",
+ "type": "string"
+ },
+ "otherAccountsInfo": {
+ "description": "List of accounts added on device (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "privilege": {
+ "description": "DMAgentPermission (Read-only)",
+ "type": "string"
+ },
+ "releaseVersion": {
+ "description": "Mobile Device release version version (Read-only)",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "The unique ID the API service uses to identify the mobile device.",
+ "type": "string"
+ },
+ "securityPatchLevel": {
+ "description": "Mobile Device Security patch level (Read-only)",
+ "format": "int64",
+ "type": "string"
+ },
+ "serialNumber": {
+ "description": "The device's serial number.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The device's status.",
+ "type": "string"
+ },
+ "supportsWorkProfile": {
+ "description": "Work profile supported on device (Read-only)",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "The type of mobile device.",
+ "type": "string"
+ },
+ "unknownSourcesStatus": {
+ "description": "Unknown sources enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "userAgent": {
+ "description": "Gives information about the device such as `os` version. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).",
+ "type": "string"
+ },
+ "wifiMacAddress": {
+ "description": "The device's MAC address on Wi-Fi networks.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDeviceAction": {
+ "id": "MobileDeviceAction",
+ "properties": {
+ "action": {
+ "annotations": {
+ "required": [
+ "directory.mobiledevices.action"
+ ]
+ },
+ "description": "The action to be performed on the device.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDevices": {
+ "id": "MobileDevices",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#mobiledevices",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "mobiledevices": {
+ "description": "List of Mobile Device objects.",
+ "items": {
+ "$ref": "MobileDevice"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrgUnit": {
+ "description": "Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).",
+ "id": "OrgUnit",
+ "properties": {
+ "blockInheritance": {
+ "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the organizational unit.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#orgUnit",
+ "description": "The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "directory.orgunits.insert"
+ ]
+ },
+ "description": "The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.",
+ "type": "string"
+ },
+ "orgUnitId": {
+ "description": "The unique ID of the organizational unit.",
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).",
+ "type": "string"
+ },
+ "parentOrgUnitId": {
+ "description": "The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.",
+ "type": "string"
+ },
+ "parentOrgUnitPath": {
+ "description": "The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrgUnits": {
+ "id": "OrgUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#orgUnits",
+ "description": "The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.",
+ "type": "string"
+ },
+ "organizationUnits": {
+ "description": "List of organizational unit objects.",
+ "items": {
+ "$ref": "OrgUnit"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Printer": {
+ "description": "Printer configuration.",
+ "id": "Printer",
+ "properties": {
+ "auxiliaryMessages": {
+ "description": "Output only. Auxiliary messages about issues with the printer configuration if any.",
+ "items": {
+ "$ref": "AuxiliaryMessage"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "createTime": {
+ "description": "Output only. Time when printer was created.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Editable. Description of printer.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Editable. Name of printer.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Id of the printer. (During printer creation leave empty)",
+ "type": "string"
+ },
+ "makeAndModel": {
+ "description": "Editable. Make and model of printer. e.g. Lexmark MS610de Value must be in format as seen in ListPrinterModels response.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)",
+ "type": "string"
+ },
+ "orgUnitId": {
+ "description": "Organization Unit that owns this printer (Only can be set during Printer creation)",
+ "type": "string"
+ },
+ "uri": {
+ "description": "Editable. Printer URI.",
+ "type": "string"
+ },
+ "useDriverlessConfig": {
+ "description": "Editable. flag to use driverless configuration or not. If it's set to be true, make_and_model can be ignored",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PrinterModel": {
+ "description": "Printer manufacturer and model",
+ "id": "PrinterModel",
+ "properties": {
+ "displayName": {
+ "description": "Display name. eq. \"Brother MFC-8840D\"",
+ "type": "string"
+ },
+ "makeAndModel": {
+ "description": "Make and model as represented in \"make_and_model\" field in Printer object. eq. \"brother mfc-8840d\"",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "Manufacturer. eq. \"Brother\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Privilege": {
+ "id": "Privilege",
+ "properties": {
+ "childPrivileges": {
+ "description": "A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.",
+ "items": {
+ "$ref": "Privilege"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "isOuScopable": {
+ "description": "If the privilege can be restricted to an organization unit.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#privilege",
+ "description": "The type of the API resource. This is always `admin#directory#privilege`.",
+ "type": "string"
},
- "Aliases": {
- "description": "JSON response template to list aliases in Directory API.",
- "id": "Aliases",
- "properties": {
- "aliases": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "etag": {
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#aliases",
- "type": "string"
- }
- },
- "type": "object"
+ "privilegeName": {
+ "description": "The name of the privilege.",
+ "type": "string"
},
- "Asp": {
- "description": "An application-specific password (ASP) is used with applications that do not accept a verification code when logging into the application on certain devices. The ASP access code is used instead of the login and password you commonly use when accessing an application through a browser. For more information about ASPs and how to create one, see the [help center](https://support.google.com/a/answer/2537800#asp).",
- "id": "Asp",
- "properties": {
- "codeId": {
- "description": "The unique ID of the ASP.",
- "format": "int32",
- "type": "integer"
- },
- "creationTime": {
- "description": "The time when the ASP was created. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.",
- "format": "int64",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the ASP.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#asp",
- "description": "The type of the API resource. This is always `admin#directory#asp`.",
- "type": "string"
- },
- "lastTimeUsed": {
- "description": "The time when the ASP was last used. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "The name of the application that the user, represented by their `userId`, entered when the ASP was created.",
- "type": "string"
- },
- "userKey": {
- "description": "The unique ID of the user who issued the ASP.",
- "type": "string"
- }
- },
- "type": "object"
+ "serviceId": {
+ "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).",
+ "type": "string"
},
- "Asps": {
- "id": "Asps",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of ASP resources.",
- "items": {
- "$ref": "Asp"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#aspList",
- "description": "The type of the API resource. This is always `admin#directory#aspList`.",
- "type": "string"
- }
- },
- "type": "object"
+ "serviceName": {
+ "description": "The name of the service this privilege is for.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Privileges": {
+ "id": "Privileges",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "AuxiliaryMessage": {
- "description": "Auxiliary message about issues with printers or settings. Example: {message_type:AUXILIARY_MESSAGE_WARNING, field_mask:make_and_model, message:\"Given printer is invalid or no longer supported.\"}",
- "id": "AuxiliaryMessage",
- "properties": {
- "auxiliaryMessage": {
- "description": "Human readable message in English. Example: \"Given printer is invalid or no longer supported.\"",
- "type": "string"
- },
- "fieldMask": {
- "description": "Field that this message concerns.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "severity": {
- "description": "Message severity",
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "SEVERITY_INFO",
- "SEVERITY_WARNING",
- "SEVERITY_ERROR"
- ],
- "enumDescriptions": [
- "Message type unspecified.",
- "Message of severity: info.",
- "Message of severity: warning.",
- "Message of severity: error."
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "items": {
+ "description": "A list of Privilege resources.",
+ "items": {
+ "$ref": "Privilege"
+ },
+ "type": "array"
},
- "BatchCreatePrintersRequest": {
- "description": "Request for adding new printers in batch.",
- "id": "BatchCreatePrintersRequest",
- "properties": {
- "requests": {
- "description": "A list of Printers to be created. Max 50 at a time.",
- "items": {
- "$ref": "CreatePrinterRequest"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#privileges",
+ "description": "The type of the API resource. This is always `admin#directory#privileges`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Role": {
+ "id": "Role",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "BatchCreatePrintersResponse": {
- "description": "Response for adding new printers in batch.",
- "id": "BatchCreatePrintersResponse",
- "properties": {
- "failures": {
- "description": "A list of create failures. Printer IDs are not populated, as printer were not created.",
- "items": {
- "$ref": "FailureInfo"
- },
- "type": "array"
- },
- "printers": {
- "description": "A list of successfully created printers with their IDs populated.",
- "items": {
- "$ref": "Printer"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "isSuperAdminRole": {
+ "description": "Returns `true` if the role is a super admin role.",
+ "type": "boolean"
},
- "BatchDeletePrintersRequest": {
- "description": "Request for deleting existing printers in batch.",
- "id": "BatchDeletePrintersRequest",
- "properties": {
- "printerIds": {
- "description": "A list of Printer.id that should be deleted. Max 100 at a time.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "isSystemRole": {
+ "description": "Returns `true` if this is a pre-defined system role.",
+ "type": "boolean"
},
- "BatchDeletePrintersResponse": {
- "description": "Response for deleting existing printers in batch.",
- "id": "BatchDeletePrintersResponse",
- "properties": {
- "failedPrinters": {
- "description": "A list of update failures.",
- "items": {
- "$ref": "FailureInfo"
- },
- "type": "array"
- },
- "printerIds": {
- "description": "A list of Printer.id that were successfully deleted.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#role",
+ "description": "The type of the API resource. This is always `admin#directory#role`.",
+ "type": "string"
},
- "Building": {
- "description": "Public API: Resources.buildings",
- "id": "Building",
- "properties": {
- "address": {
- "$ref": "BuildingAddress",
- "description": "The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required."
- },
- "buildingId": {
- "description": "Unique identifier for the building. The maximum length is 100 characters.",
- "type": "string"
- },
- "buildingName": {
- "description": "The building name as seen by users in Calendar. Must be unique for the customer. For example, \"NYC-CHEL\". The maximum length is 100 characters.",
- "type": "string"
- },
- "coordinates": {
- "$ref": "BuildingCoordinates",
- "description": "The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees."
- },
- "description": {
- "description": "A brief description of the building. For example, \"Chelsea Market\".",
- "type": "string"
- },
- "etags": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "floorNames": {
- "description": "The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, [\"B2\", \"B1\", \"L\", \"1\", \"2\", \"2M\", \"3\", \"PH\"] Must contain at least one entry.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#resources#buildings#Building",
- "description": "Kind of resource this is.",
- "type": "string"
- }
- },
- "type": "object"
+ "roleDescription": {
+ "description": "A short description of the role.",
+ "type": "string"
},
- "BuildingAddress": {
- "description": "Public API: Resources.buildings",
- "id": "BuildingAddress",
- "properties": {
- "addressLines": {
- "description": "Unstructured address lines describing the lower levels of an address.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "administrativeArea": {
- "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region.",
- "type": "string"
- },
- "languageCode": {
- "description": "Optional. BCP-47 language code of the contents of this address (if known).",
- "type": "string"
- },
- "locality": {
- "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.",
- "type": "string"
- },
- "postalCode": {
- "description": "Optional. Postal code of the address.",
- "type": "string"
- },
- "regionCode": {
- "description": "Required. CLDR region code of the country/region of the address.",
- "type": "string"
- },
- "sublocality": {
- "description": "Optional. Sublocality of the address.",
- "type": "string"
- }
- },
- "type": "object"
+ "roleId": {
+ "description": "ID of the role.",
+ "format": "int64",
+ "type": "string"
},
- "BuildingCoordinates": {
- "description": "Public API: Resources.buildings",
- "id": "BuildingCoordinates",
- "properties": {
- "latitude": {
- "description": "Latitude in decimal degrees.",
- "format": "double",
- "type": "number"
- },
- "longitude": {
- "description": "Longitude in decimal degrees.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
+ "roleName": {
+ "annotations": {
+ "required": [
+ "directory.roles.insert"
+ ]
+ },
+ "description": "Name of the role.",
+ "type": "string"
},
- "Buildings": {
- "description": "Public API: Resources.buildings",
- "id": "Buildings",
+ "rolePrivileges": {
+ "annotations": {
+ "required": [
+ "directory.roles.insert"
+ ]
+ },
+ "description": "The set of privileges that are granted to this role.",
+ "items": {
"properties": {
- "buildings": {
- "description": "The Buildings in this page of results.",
- "items": {
- "$ref": "Building"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#resources#buildings#buildingsList",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
- "type": "string"
- }
+ "privilegeName": {
+ "description": "The name of the privilege.",
+ "type": "string"
+ },
+ "serviceId": {
+ "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).",
+ "type": "string"
+ }
},
"type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RoleAssignment": {
+ "description": "Defines an assignment of a role.",
+ "id": "RoleAssignment",
+ "properties": {
+ "assignedTo": {
+ "description": "The unique ID of the user this role is assigned to.",
+ "type": "string"
},
- "CalendarResource": {
- "description": "Public API: Resources.calendars",
- "id": "CalendarResource",
- "properties": {
- "buildingId": {
- "description": "Unique ID for the building a resource is located in.",
- "type": "string"
- },
- "capacity": {
- "description": "Capacity of a resource, number of seats in a room.",
- "format": "int32",
- "type": "integer"
- },
- "etags": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "featureInstances": {
- "description": "Instances of features for the calendar resource.",
- "type": "any"
- },
- "floorName": {
- "description": "Name of the floor a resource is located on.",
- "type": "string"
- },
- "floorSection": {
- "description": "Name of the section within a floor a resource is located in.",
- "type": "string"
- },
- "generatedResourceName": {
- "description": "The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, \"NYC-2-Training Room 1A (16)\".",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#resources#calendars#CalendarResource",
- "description": "The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`.",
- "type": "string"
- },
- "resourceCategory": {
- "description": "The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.",
- "type": "string"
- },
- "resourceDescription": {
- "description": "Description of the resource, visible only to admins.",
- "type": "string"
- },
- "resourceEmail": {
- "description": "The read-only email for the calendar resource. Generated as part of creating a new calendar resource.",
- "type": "string"
- },
- "resourceId": {
- "annotations": {
- "required": [
- "directory.resources.calendars.insert"
- ]
- },
- "description": "The unique ID for the calendar resource.",
- "type": "string"
- },
- "resourceName": {
- "annotations": {
- "required": [
- "directory.resources.calendars.insert"
- ]
- },
- "description": "The name of the calendar resource. For example, \"Training Room 1A\".",
- "type": "string"
- },
- "resourceType": {
- "description": "The type of the calendar resource, intended for non-room resources.",
- "type": "string"
- },
- "userVisibleDescription": {
- "description": "Description of the resource, visible to users and admins.",
- "type": "string"
- }
- },
- "type": "object"
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "CalendarResources": {
- "description": "Public API: Resources.calendars",
- "id": "CalendarResources",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "The CalendarResources in this page of results.",
- "items": {
- "$ref": "CalendarResource"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#resources#calendars#calendarResourcesList",
- "description": "Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
- "type": "string"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#roleAssignment",
+ "description": "The type of the API resource. This is always `admin#directory#roleAssignment`.",
+ "type": "string"
},
- "Channel": {
- "description": "An notification channel used to watch for resource changes.",
- "id": "Channel",
- "properties": {
- "address": {
- "description": "The address where notifications are delivered for this channel.",
- "type": "string"
- },
- "expiration": {
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "A UUID or similar unique string that identifies this channel.",
- "type": "string"
- },
- "kind": {
- "default": "api#channel",
- "description": "Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.",
- "type": "string"
- },
- "params": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "type": "object"
- },
- "payload": {
- "description": "A Boolean value to indicate whether payload is wanted. Optional.",
- "type": "boolean"
- },
- "resourceId": {
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
- "type": "string"
- },
- "resourceUri": {
- "description": "A version-specific identifier for the watched resource.",
- "type": "string"
- },
- "token": {
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
- "type": "string"
- },
- "type": {
- "description": "The type of delivery mechanism used for this channel.",
- "type": "string"
- }
- },
- "type": "object"
+ "orgUnitId": {
+ "description": "If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.",
+ "type": "string"
},
- "ChromeOsDevice": {
- "description": "Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).",
- "id": "ChromeOsDevice",
- "properties": {
- "activeTimeRanges": {
- "description": "List of active time ranges (Read-only).",
- "items": {
- "properties": {
- "activeTime": {
- "description": "Duration of usage in milliseconds.",
- "format": "int32",
- "type": "integer"
- },
- "date": {
- "description": "Date of usage",
- "format": "date",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "annotatedAssetId": {
- "description": "The asset identifier as noted by an administrator or specified during enrollment.",
- "type": "string"
- },
- "annotatedLocation": {
- "description": "The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.",
- "type": "string"
- },
- "annotatedUser": {
- "description": "The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.",
- "type": "string"
- },
- "autoUpdateExpiration": {
- "description": "(Read-only) The timestamp after which the device will stop receiving Chrome updates or support",
- "format": "int64",
- "type": "string"
- },
- "bootMode": {
- "description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).",
- "type": "string"
- },
- "cpuStatusReports": {
- "description": "Reports of CPU utilization and temperature (Read-only)",
- "items": {
- "properties": {
- "cpuTemperatureInfo": {
- "description": "List of CPU temperature samples.",
- "items": {
- "properties": {
- "label": {
- "description": "CPU label",
- "type": "string"
- },
- "temperature": {
- "description": "Temperature in Celsius degrees.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "cpuUtilizationPercentageInfo": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "reportTime": {
- "description": "Date and time the report was received.",
- "format": "date-time",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "deviceFiles": {
- "description": "List of device files to download (Read-only)",
- "items": {
- "properties": {
- "createTime": {
- "description": "Date and time the file was created",
- "format": "date-time",
- "type": "string"
- },
- "downloadUrl": {
- "description": "File download URL",
- "type": "string"
- },
- "name": {
- "description": "File name",
- "type": "string"
- },
- "type": {
- "description": "File type",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "deviceId": {
- "description": "The unique ID of the Chrome device.",
- "type": "string"
- },
- "diskVolumeReports": {
- "description": "Reports of disk space and other info about mounted/connected volumes.",
- "items": {
- "properties": {
- "volumeInfo": {
- "description": "Disk volumes",
- "items": {
- "properties": {
- "storageFree": {
- "description": "Free disk space [in bytes]",
- "format": "int64",
- "type": "string"
- },
- "storageTotal": {
- "description": "Total disk space [in bytes]",
- "format": "int64",
- "type": "string"
- },
- "volumeId": {
- "description": "Volume id",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "dockMacAddress": {
- "description": "(Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "ethernetMacAddress": {
- "description": "The device's MAC address on the ethernet network interface.",
- "type": "string"
- },
- "ethernetMacAddress0": {
- "description": "(Read-only) MAC address used by the Chromebook\u2019s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.",
- "type": "string"
- },
- "firmwareVersion": {
- "description": "The Chrome device's firmware version.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#chromeosdevice",
- "description": "The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.",
- "type": "string"
- },
- "lastEnrollmentTime": {
- "description": "Date and time the device was last enrolled (Read-only)",
- "format": "date-time",
- "type": "string"
- },
- "lastKnownNetwork": {
- "description": "Contains last known network (Read-only)",
- "items": {
- "description": "Information for an ip address.",
- "properties": {
- "ipAddress": {
- "description": "The IP address.",
- "type": "string"
- },
- "wanIpAddress": {
- "description": "The WAN IP address.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "lastSync": {
- "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time",
- "type": "string"
- },
- "macAddress": {
- "description": "The device's wireless MAC address. If the device does not have this information, it is not included in the response.",
- "type": "string"
- },
- "manufactureDate": {
- "description": "(Read-only) The date the device was manufactured in yyyy-mm-dd format.",
- "type": "string"
- },
- "meid": {
- "description": "The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).",
- "type": "string"
- },
- "model": {
- "description": "The device's model information. If the device does not have this information, this property is not included in the response.",
- "type": "string"
- },
- "notes": {
- "description": "Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.",
- "type": "string"
- },
- "orderNumber": {
- "description": "The device's order number. Only devices directly purchased from Google have an order number.",
- "type": "string"
- },
- "orgUnitPath": {
- "description": "The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).",
- "type": "string"
- },
- "osVersion": {
- "description": "The Chrome device's operating system version.",
- "type": "string"
- },
- "platformVersion": {
- "description": "The Chrome device's platform version.",
- "type": "string"
- },
- "recentUsers": {
- "description": "List of recent device users, in descending order, by last login time.",
- "items": {
- "$ref": "RecentUsers"
- },
- "type": "array"
- },
- "screenshotFiles": {
- "description": "List of screenshot files to download. Type is always \"SCREENSHOT_FILE\". (Read-only)",
- "items": {
- "properties": {
- "createTime": {
- "description": "Date and time the file was created",
- "format": "date-time",
- "type": "string"
- },
- "downloadUrl": {
- "description": "File download URL",
- "type": "string"
- },
- "name": {
- "description": "File name",
- "type": "string"
- },
- "type": {
- "description": "File type",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "serialNumber": {
- "description": "The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.",
- "type": "string"
- },
- "status": {
- "description": "The status of the device.",
- "type": "string"
- },
- "supportEndDate": {
- "description": "Final date the device will be supported (Read-only)",
- "format": "date-time",
- "type": "string"
- },
- "systemRamFreeReports": {
- "description": "Reports of amounts of available RAM memory (Read-only)",
- "items": {
- "properties": {
- "reportTime": {
- "description": "Date and time the report was received.",
- "format": "date-time",
- "type": "string"
- },
- "systemRamFreeInfo": {
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "systemRamTotal": {
- "description": "Total RAM on the device [in bytes] (Read-only)",
- "format": "int64",
- "type": "string"
- },
- "tpmVersionInfo": {
- "description": "Trusted Platform Module (TPM) (Read-only)",
- "properties": {
- "family": {
- "description": "TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: \"1.2\" -> 312e3200 TPM 2.0: \"2.0\" -> 322e3000",
- "type": "string"
- },
- "firmwareVersion": {
- "description": "TPM firmware version.",
- "type": "string"
- },
- "manufacturer": {
- "description": "TPM manufacturer code.",
- "type": "string"
- },
- "specLevel": {
- "description": "TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.",
- "type": "string"
- },
- "tpmModel": {
- "description": "TPM model number.",
- "type": "string"
- },
- "vendorSpecific": {
- "description": "Vendor-specific information such as Vendor ID.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "willAutoRenew": {
- "description": "Determines if the device will auto renew its support after the support end date. This is a read-only property.",
- "type": "boolean"
- }
+ "roleAssignmentId": {
+ "description": "ID of this roleAssignment.",
+ "format": "int64",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "The ID of the role that is assigned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "scopeType": {
+ "description": "The scope in which this role is assigned.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RoleAssignments": {
+ "id": "RoleAssignments",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of RoleAssignment resources.",
+ "items": {
+ "$ref": "RoleAssignment"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#roleAssignments",
+ "description": "The type of the API resource. This is always `admin#directory#roleAssignments`.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Roles": {
+ "id": "Roles",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Role resources.",
+ "items": {
+ "$ref": "Role"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#roles",
+ "description": "The type of the API resource. This is always `admin#directory#roles`.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schema": {
+ "description": "The type of API resource. For Schema resources, this is always `admin#directory#schema`.",
+ "id": "Schema",
+ "properties": {
+ "displayName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert"
+ ]
+ },
+ "description": "Display name for the schema.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The ETag of the resource.",
+ "type": "string"
+ },
+ "fields": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "A list of fields in the schema.",
+ "items": {
+ "$ref": "SchemaFieldSpec"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#schema",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "schemaId": {
+ "description": "The unique identifier of the schema (Read-only)",
+ "type": "string"
+ },
+ "schemaName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert"
+ ]
+ },
+ "description": "The schema's name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SchemaFieldSpec": {
+ "description": "You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).",
+ "id": "SchemaFieldSpec",
+ "properties": {
+ "displayName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "Display Name of the field.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The ETag of the field.",
+ "type": "string"
+ },
+ "fieldId": {
+ "description": "The unique identifier of the field (Read-only)",
+ "type": "string"
+ },
+ "fieldName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "The name of the field.",
+ "type": "string"
+ },
+ "fieldType": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "The type of the field.",
+ "type": "string"
+ },
+ "indexed": {
+ "default": "true",
+ "description": "Boolean specifying whether the field is indexed or not. Default: `true`.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#schema#fieldspec",
+ "description": "The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.",
+ "type": "string"
+ },
+ "multiValued": {
+ "description": "A boolean specifying whether this is a multi-valued field or not. Default: `false`.",
+ "type": "boolean"
+ },
+ "numericIndexingSpec": {
+ "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.",
+ "properties": {
+ "maxValue": {
+ "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
+ "format": "double",
+ "type": "number"
},
- "type": "object"
+ "minValue": {
+ "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "readAccessType": {
+ "default": "ALL_DOMAIN_USERS",
+ "description": "Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schemas": {
+ "description": "JSON response template for List Schema operation in Directory API.",
+ "id": "Schemas",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#schemas",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "schemas": {
+ "description": "List of UserSchema objects.",
+ "items": {
+ "$ref": "Schema"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Token": {
+ "description": "JSON template for token resource in Directory API.",
+ "id": "Token",
+ "properties": {
+ "anonymous": {
+ "description": "Whether the application is registered with Google. The value is `true` if the application has an anonymous Client ID.",
+ "type": "boolean"
+ },
+ "clientId": {
+ "description": "The Client ID of the application the token is issued to.",
+ "type": "string"
+ },
+ "displayText": {
+ "description": "The displayable name of the application the token is issued to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#token",
+ "description": "The type of the API resource. This is always `admin#directory#token`.",
+ "type": "string"
+ },
+ "nativeApp": {
+ "description": "Whether the token is issued to an installed application. The value is `true` if the application is installed to a desktop or mobile device.",
+ "type": "boolean"
+ },
+ "scopes": {
+ "description": "A list of authorization scopes the application is granted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userKey": {
+ "description": "The unique ID of the user that issued the token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Tokens": {
+ "description": "JSON response template for List tokens operation in Directory API.",
+ "id": "Tokens",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Token resources.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#tokenList",
+ "description": "The type of the API resource. This is always `admin#directory#tokenList`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).",
+ "id": "User",
+ "properties": {
+ "addresses": {
+ "description": "A list of the user's addresses. The maximum allowed data size for this field is 10Kb.",
+ "type": "any"
+ },
+ "agreedToTerms": {
+ "description": "Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "Output only. List of the user's alias email addresses.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
},
- "ChromeOsDeviceAction": {
- "id": "ChromeOsDeviceAction",
- "properties": {
- "action": {
- "annotations": {
- "required": [
- "directory.chromeosdevices.action"
- ]
- },
- "description": "Action to be taken on the Chrome OS device.",
- "type": "string"
- },
- "deprovisionReason": {
- "description": "Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.",
- "type": "string"
- }
- },
- "type": "object"
+ "archived": {
+ "description": "Indicates if user is archived.",
+ "type": "boolean"
},
- "ChromeOsDevices": {
- "id": "ChromeOsDevices",
- "properties": {
- "chromeosdevices": {
- "description": "List of Chrome OS Device objects.",
- "items": {
- "$ref": "ChromeOsDevice"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#chromeosdevices",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.",
- "type": "string"
- }
- },
- "type": "object"
+ "changePasswordAtNextLogin": {
+ "description": "Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224).",
+ "type": "boolean"
},
- "ChromeOsMoveDevicesToOu": {
- "id": "ChromeOsMoveDevicesToOu",
- "properties": {
- "deviceIds": {
- "annotations": {
- "required": [
- "directory.chromeosdevices.moveDevicesToOu"
- ]
- },
- "description": "Chrome OS devices to be moved to OU",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "creationTime": {
+ "description": "User's G Suite account creation time. (Read-only)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
},
- "CreatePrinterRequest": {
- "description": "Request for adding a new printer.",
- "id": "CreatePrinterRequest",
- "properties": {
- "parent": {
- "description": "Required. The name of the customer. Format: customers/{customer_id}",
- "type": "string"
- },
- "printer": {
- "$ref": "Printer",
- "description": "Required. A printer to create. If you want to place the printer under particular OU then populate printer.org_unit_id filed. Otherwise the printer will be placed under root OU."
- }
- },
- "type": "object"
+ "customSchemas": {
+ "additionalProperties": {
+ "$ref": "UserCustomProperties"
+ },
+ "description": "Custom fields of the user.",
+ "type": "object"
},
- "Customer": {
- "id": "Customer",
- "properties": {
- "alternateEmail": {
- "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain`",
- "type": "string"
- },
- "customerCreationTime": {
- "description": "The customer's creation time (Readonly)",
- "format": "date-time",
- "type": "string"
- },
- "customerDomain": {
- "description": "The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "id": {
- "description": "The unique ID for the customer's Google Workspace account. (Readonly)",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#customer",
- "description": "Identifies the resource as a customer. Value: `admin#directory#customer`",
- "type": "string"
- },
- "language": {
- "description": "The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.",
- "type": "string"
- },
- "postalAddress": {
- "$ref": "CustomerPostalAddress",
- "description": "The customer's postal address information."
- }
- },
- "type": "object"
+ "customerId": {
+ "description": "Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.",
+ "readOnly": true,
+ "type": "string"
},
- "CustomerPostalAddress": {
- "id": "CustomerPostalAddress",
- "properties": {
- "addressLine1": {
- "description": "A customer's physical address. The address can be composed of one to three lines.",
- "type": "string"
- },
- "addressLine2": {
- "description": "Address line 2 of the address.",
- "type": "string"
- },
- "addressLine3": {
- "description": "Address line 3 of the address.",
- "type": "string"
- },
- "contactName": {
- "description": "The customer contact's name.",
- "type": "string"
- },
- "countryCode": {
- "description": "This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).",
- "type": "string"
- },
- "locality": {
- "description": "Name of the locality. An example of a locality value is the city of `San Francisco`.",
- "type": "string"
- },
- "organizationName": {
- "description": "The company or company division name.",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.",
- "type": "string"
- },
- "region": {
- "description": "Name of the region. An example of a region value is `NY` for the state of New York.",
- "type": "string"
- }
- },
- "type": "object"
+ "deletionTime": {
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
},
- "DirectoryChromeosdevicesCommand": {
- "description": "Information regarding a command that was issued to a device.",
- "id": "DirectoryChromeosdevicesCommand",
- "properties": {
- "commandExpireTime": {
- "description": "The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired.",
- "format": "google-datetime",
- "type": "string"
- },
- "commandId": {
- "description": "Unique ID of a device command.",
- "format": "int64",
- "type": "string"
- },
- "commandResult": {
- "$ref": "DirectoryChromeosdevicesCommandResult",
- "description": "The result of the command execution."
- },
- "issueTime": {
- "description": "The timestamp when the command was issued by the admin.",
- "format": "google-datetime",
- "type": "string"
- },
- "payload": {
- "description": "The payload that the command specified, if any.",
- "type": "string"
- },
- "state": {
- "description": "Indicates the command state.",
- "enum": [
- "STATE_UNSPECIFIED",
- "PENDING",
- "EXPIRED",
- "CANCELLED",
- "SENT_TO_CLIENT",
- "ACKED_BY_CLIENT",
- "EXECUTED_BY_CLIENT"
- ],
- "enumDescriptions": [
- "The command status was unspecified.",
- "An unexpired command not yet sent to the client.",
- "The command didn't get executed by the client within the expected time.",
- "The command is cancelled by admin while in PENDING.",
- "The command has been sent to the client.",
- "The client has responded that it received the command.",
- "The client has (un)successfully executed the command."
- ],
- "type": "string"
- },
- "type": {
- "description": "The type of the command.",
- "enum": [
- "COMMAND_TYPE_UNSPECIFIED",
- "REBOOT",
- "TAKE_A_SCREENSHOT",
- "SET_VOLUME",
- "WIPE_USERS",
- "REMOTE_POWERWASH"
- ],
- "enumDescriptions": [
- "The command type was unspecified.",
- "Reboot the device. Can only be issued to Kiosk and managed guest session devices.",
- "Take a screenshot of the device. Only available if the device is in Kiosk Mode.",
- "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
- "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
- "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!"
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "emails": {
+ "description": "A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.",
+ "type": "any"
},
- "DirectoryChromeosdevicesCommandResult": {
- "description": "The result of executing a command.",
- "id": "DirectoryChromeosdevicesCommandResult",
- "properties": {
- "errorMessage": {
- "description": "The error message with a short explanation as to why the command failed. Only present if the command failed.",
- "type": "string"
- },
- "executeTime": {
- "description": "The time at which the command was executed or failed to execute.",
- "format": "google-datetime",
- "type": "string"
- },
- "result": {
- "description": "The result of the command.",
- "enum": [
- "COMMAND_RESULT_TYPE_UNSPECIFIED",
- "IGNORED",
- "FAILURE",
- "SUCCESS"
- ],
- "enumDescriptions": [
- "The command result was unspecified.",
- "The command was ignored as obsolete.",
- "The command could not be executed successfully.",
- "The command was successfully executed."
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "etag": {
+ "description": "Output only. ETag of the resource.",
+ "readOnly": true,
+ "type": "string"
},
- "DirectoryChromeosdevicesIssueCommandRequest": {
- "description": "A request for issuing a command.",
- "id": "DirectoryChromeosdevicesIssueCommandRequest",
- "properties": {
- "commandType": {
- "description": "The type of command.",
- "enum": [
- "COMMAND_TYPE_UNSPECIFIED",
- "REBOOT",
- "TAKE_A_SCREENSHOT",
- "SET_VOLUME",
- "WIPE_USERS",
- "REMOTE_POWERWASH"
- ],
- "enumDescriptions": [
- "The command type was unspecified.",
- "Reboot the device. Can only be issued to Kiosk and managed guest session devices.",
- "Take a screenshot of the device. Only available if the device is in Kiosk Mode.",
- "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
- "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
- "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!"
- ],
- "type": "string"
- },
- "payload": {
- "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: - SET_VOLUME: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100].",
- "type": "string"
- }
- },
- "type": "object"
+ "externalIds": {
+ "description": "A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.",
+ "type": "any"
},
- "DirectoryChromeosdevicesIssueCommandResponse": {
- "description": "A response for issuing a command.",
- "id": "DirectoryChromeosdevicesIssueCommandResponse",
- "properties": {
- "commandId": {
- "description": "The unique ID of the issued command, used to retrieve the command status.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "gender": {
+ "description": "The user's gender. The maximum allowed data size for this field is 1Kb.",
+ "type": "any"
},
- "DomainAlias": {
- "id": "DomainAlias",
- "properties": {
- "creationTime": {
- "description": "The creation time of the domain alias. (Read-only).",
- "format": "int64",
- "type": "string"
- },
- "domainAliasName": {
- "description": "The domain alias name.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#domainAlias",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "parentDomainName": {
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- },
- "description": "The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.",
- "type": "string"
- },
- "verified": {
- "description": "Indicates the verification state of a domain alias. (Read-only)",
- "type": "boolean"
- }
- },
- "type": "object"
+ "hashFunction": {
+ "description": "Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\\(C\\)) hash format.",
+ "type": "string"
},
- "DomainAliases": {
- "id": "DomainAliases",
- "properties": {
- "domainAliases": {
- "description": "List of domain alias objects.",
- "items": {
- "$ref": "DomainAlias"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#domainAliases",
- "description": "Kind of resource this is.",
- "type": "string"
- }
- },
- "type": "object"
+ "id": {
+ "description": "The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.",
+ "type": "string"
},
- "Domains": {
- "id": "Domains",
- "properties": {
- "creationTime": {
- "description": "Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).",
- "format": "int64",
- "type": "string"
- },
- "domainAliases": {
- "description": "List of domain alias objects. (Read-only)",
- "items": {
- "$ref": "DomainAlias"
- },
- "type": "array"
- },
- "domainName": {
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- },
- "description": "The domain name of the customer.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "isPrimary": {
- "description": "Indicates if the domain is a primary domain (Read-only).",
- "type": "boolean"
- },
- "kind": {
- "default": "admin#directory#domain",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "verified": {
- "description": "Indicates the verification state of a domain. (Read-only).",
- "type": "boolean"
- }
- },
- "type": "object"
+ "ims": {
+ "description": "The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.",
+ "type": "any"
},
- "Domains2": {
- "id": "Domains2",
- "properties": {
- "domains": {
- "description": "List of domain objects.",
- "items": {
- "$ref": "Domains"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#domains",
- "description": "Kind of resource this is.",
- "type": "string"
- }
- },
- "type": "object"
+ "includeInGlobalAddressList": {
+ "description": "Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).",
+ "type": "boolean"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
- "id": "Empty",
- "properties": {},
- "type": "object"
+ "ipWhitelisted": {
+ "description": "If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).",
+ "type": "boolean"
},
- "FailureInfo": {
- "description": "Info about failures",
- "id": "FailureInfo",
- "properties": {
- "errorCode": {
- "description": "Canonical code for why the update failed to apply.",
- "enum": [
- "OK",
- "CANCELLED",
- "UNKNOWN",
- "INVALID_ARGUMENT",
- "DEADLINE_EXCEEDED",
- "NOT_FOUND",
- "ALREADY_EXISTS",
- "PERMISSION_DENIED",
- "UNAUTHENTICATED",
- "RESOURCE_EXHAUSTED",
- "FAILED_PRECONDITION",
- "ABORTED",
- "OUT_OF_RANGE",
- "UNIMPLEMENTED",
- "INTERNAL",
- "UNAVAILABLE",
- "DATA_LOSS"
- ],
- "enumDescriptions": [
- "Not an error; returned on success HTTP Mapping: 200 OK",
- "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
- "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
- "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
- "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
- "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
- "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
- "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
- "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
- "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
- "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
- "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
- "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
- "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
- "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
- "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
- "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
- ],
- "type": "string"
- },
- "errorMessage": {
- "description": "Failure reason message.",
- "type": "string"
- },
- "printer": {
- "$ref": "Printer",
- "description": "Failed printer."
- },
- "printerId": {
- "description": "Id of a failed printer.",
- "type": "string"
- }
- },
- "type": "object"
+ "isAdmin": {
+ "description": "Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.",
+ "readOnly": true,
+ "type": "boolean"
},
- "Feature": {
- "description": "JSON template for Feature object in Directory API.",
- "id": "Feature",
- "properties": {
- "etags": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#resources#features#Feature",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "name": {
- "annotations": {
- "required": [
- "directory.resources.features.insert"
- ]
- },
- "description": "The name of the feature.",
- "type": "string"
- }
- },
- "type": "object"
+ "isDelegatedAdmin": {
+ "description": "Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).",
+ "readOnly": true,
+ "type": "boolean"
},
- "FeatureInstance": {
- "description": "JSON template for a feature instance.",
- "id": "FeatureInstance",
- "properties": {
- "feature": {
- "$ref": "Feature",
- "description": "The feature that this is an instance of. A calendar resource may have multiple instances of a feature."
- }
- },
- "type": "object"
+ "isEnforcedIn2Sv": {
+ "description": "Output only. Is 2-step verification enforced (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
},
- "FeatureRename": {
- "id": "FeatureRename",
- "properties": {
- "newName": {
- "annotations": {
- "required": [
- "directory.resources.features.rename"
- ]
- },
- "description": "New name of the feature.",
- "type": "string"
- }
- },
- "type": "object"
+ "isEnrolledIn2Sv": {
+ "description": "Output only. Is enrolled in 2-step verification (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
},
- "Features": {
- "description": "Public API: Resources.features",
- "id": "Features",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "features": {
- "description": "The Features in this page of results.",
- "items": {
- "$ref": "Feature"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#resources#features#featuresList",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
- "type": "string"
- }
- },
- "type": "object"
+ "isMailboxSetup": {
+ "description": "Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.",
+ "readOnly": true,
+ "type": "boolean"
},
- "Group": {
- "description": "Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).",
- "id": "Group",
- "properties": {
- "adminCreated": {
- "description": "Value is `true` if this group was created by an administrator rather than a user.",
- "type": "boolean"
- },
- "aliases": {
- "description": "List of a group's alias email addresses.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.",
- "type": "string"
- },
- "directMembersCount": {
- "description": "The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "annotations": {
- "required": [
- "directory.groups.insert"
- ]
- },
- "description": "The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "id": {
- "description": "The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#group",
- "description": "The type of the API resource. For Groups resources, the value is `admin#directory#group`.",
- "type": "string"
- },
- "name": {
- "description": "The group's display name.",
- "type": "string"
- },
- "nonEditableAliases": {
- "description": "List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "keywords": {
+ "description": "The user's keywords. The maximum allowed data size for this field is 1Kb.",
+ "type": "any"
},
- "Groups": {
- "id": "Groups",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "groups": {
- "description": "List of group objects.",
- "items": {
- "$ref": "Group"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#groups",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Token used to access next page of this result.",
- "type": "string"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#user",
+ "description": "Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.",
+ "readOnly": true,
+ "type": "string"
},
- "ListPrinterModelsResponse": {
- "description": "Response for listing allowed printer models.",
- "id": "ListPrinterModelsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "printerModels": {
- "description": "Printer models that are currently allowed to be configured for ChromeOs. Some printers may be added or removed over time.",
- "items": {
- "$ref": "PrinterModel"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "languages": {
+ "description": "The user's languages. The maximum allowed data size for this field is 1Kb.",
+ "type": "any"
},
- "ListPrintersResponse": {
- "description": "Response for listing printers.",
- "id": "ListPrintersResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "printers": {
- "description": "List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was given in the request, then all printers will be returned.",
- "items": {
- "$ref": "Printer"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "lastLoginTime": {
+ "description": "User's last login time. (Read-only)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
},
- "Member": {
- "description": "A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).",
- "id": "Member",
- "properties": {
- "delivery_settings": {
- "description": "Defines mail delivery preferences of member. This is only supported by create/update/get.",
- "type": "string"
- },
- "email": {
- "description": "The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "id": {
- "description": "The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#member",
- "description": "The type of the API resource. For Members resources, the value is `admin#directory#member`.",
- "type": "string"
- },
- "role": {
- "description": "The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).",
- "type": "string"
- },
- "status": {
- "description": "Status of member (Immutable)",
- "type": "string"
- },
- "type": {
- "description": "The type of group member.",
- "type": "string"
- }
- },
- "type": "object"
+ "locations": {
+ "description": "The user's locations. The maximum allowed data size for this field is 10Kb.",
+ "type": "any"
+ },
+ "name": {
+ "$ref": "UserName",
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb."
+ },
+ "nonEditableAliases": {
+ "description": "Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "notes": {
+ "description": "Notes for the user.",
+ "type": "any"
+ },
+ "orgUnitPath": {
+ "description": "The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).",
+ "type": "string"
+ },
+ "organizations": {
+ "description": "A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.",
+ "type": "any"
+ },
+ "password": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "User's password",
+ "type": "string"
+ },
+ "phones": {
+ "description": "A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.",
+ "type": "any"
+ },
+ "posixAccounts": {
+ "description": "A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.",
+ "type": "any"
+ },
+ "primaryEmail": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user.",
+ "type": "string"
+ },
+ "recoveryEmail": {
+ "description": "Recovery email of the user.",
+ "type": "string"
+ },
+ "recoveryPhone": {
+ "description": "Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*.",
+ "type": "string"
+ },
+ "relations": {
+ "description": "A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.",
+ "type": "any"
+ },
+ "sshPublicKeys": {
+ "description": "A list of SSH public keys.",
+ "type": "any"
+ },
+ "suspended": {
+ "description": "Indicates if user is suspended.",
+ "type": "boolean"
+ },
+ "suspensionReason": {
+ "description": "Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "thumbnailPhotoEtag": {
+ "description": "Output only. ETag of the user's photo (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "thumbnailPhotoUrl": {
+ "description": "Output only. Photo Url of the user (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "websites": {
+ "description": "The user's websites. The maximum allowed data size for this field is 2Kb.",
+ "type": "any"
+ }
+ },
+ "type": "object"
+ },
+ "UserAbout": {
+ "description": "JSON template for About (notes) of a user in Directory API.",
+ "id": "UserAbout",
+ "properties": {
+ "contentType": {
+ "description": "About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Actual value of notes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserAddress": {
+ "description": "JSON template for address.",
+ "id": "UserAddress",
+ "properties": {
+ "country": {
+ "description": "Country.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "extendedAddress": {
+ "description": "Extended Address.",
+ "type": "string"
+ },
+ "formatted": {
+ "description": "Formatted address.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Locality.",
+ "type": "string"
+ },
+ "poBox": {
+ "description": "Other parts of address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary address. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "region": {
+ "description": "Region.",
+ "type": "string"
+ },
+ "sourceIsStructured": {
+ "description": "User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses but any values will eventually be clobbered.",
+ "type": "boolean"
+ },
+ "streetAddress": {
+ "description": "Street.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Each entry can have a type which indicates standard values of that entry. For example address could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserCustomProperties": {
+ "additionalProperties": {
+ "type": "any"
+ },
+ "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
+ "id": "UserCustomProperties",
+ "type": "object"
+ },
+ "UserEmail": {
+ "description": "JSON template for an email.",
+ "id": "UserEmail",
+ "properties": {
+ "address": {
+ "description": "Email id of the user.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary email. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserExternalId": {
+ "description": "JSON template for an externalId entry.",
+ "id": "UserExternalId",
+ "properties": {
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the Id.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the id.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserGender": {
+ "id": "UserGender",
+ "properties": {
+ "addressMeAs": {
+ "description": "AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans for example he/him/his or they/them/their.",
+ "type": "string"
+ },
+ "customGender": {
+ "description": "Custom gender.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Gender.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserIm": {
+ "description": "JSON template for instant messenger of an user.",
+ "id": "UserIm",
+ "properties": {
+ "customProtocol": {
+ "description": "Custom protocol.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "im": {
+ "description": "Instant messenger id.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary im. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "protocol": {
+ "description": "Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type it can take a CUSTOM value and specify the custom name in customProtocol field.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserKeyword": {
+ "description": "JSON template for a keyword entry.",
+ "id": "UserKeyword",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Each entry can have a type which indicates standard type of that entry. For example keyword could be of type occupation or outlook. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Keyword.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserLanguage": {
+ "description": "JSON template for a language entry.",
+ "id": "UserLanguage",
+ "properties": {
+ "customLanguage": {
+ "description": "Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserLocation": {
+ "description": "JSON template for a location entry.",
+ "id": "UserLocation",
+ "properties": {
+ "area": {
+ "description": "Textual location. This is most useful for display purposes to concisely describe the location. For example 'Mountain View, CA', 'Near Seattle', 'US-NYC-9TH 9A209A.''",
+ "type": "string"
},
- "Members": {
- "id": "Members",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#members",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "members": {
- "description": "List of member objects.",
- "items": {
- "$ref": "Member"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Token used to access next page of this result.",
- "type": "string"
- }
- },
- "type": "object"
+ "buildingId": {
+ "description": "Building Identifier.",
+ "type": "string"
},
- "MembersHasMember": {
- "description": "JSON template for Has Member response in Directory API.",
- "id": "MembersHasMember",
- "properties": {
- "isMember": {
- "description": "Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.",
- "readOnly": true,
- "type": "boolean"
- }
- },
- "type": "object"
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
},
- "MobileDevice": {
- "description": "Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html).",
- "id": "MobileDevice",
- "properties": {
- "adbStatus": {
- "description": "Adb (USB debugging) enabled or disabled on device (Read-only)",
- "type": "boolean"
- },
- "applications": {
- "description": "The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.",
- "items": {
- "properties": {
- "displayName": {
- "description": "The application's display name. An example is `Browser`.",
- "type": "string"
- },
- "packageName": {
- "description": "The application's package name. An example is `com.android.browser`.",
- "type": "string"
- },
- "permission": {
- "description": "The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "versionCode": {
- "description": "The application's version code. An example is `13`.",
- "format": "int32",
- "type": "integer"
- },
- "versionName": {
- "description": "The application's version name. An example is `3.2-140714`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "basebandVersion": {
- "description": "The device's baseband version.",
- "type": "string"
- },
- "bootloaderVersion": {
- "description": "Mobile Device Bootloader version (Read-only)",
- "type": "string"
- },
- "brand": {
- "description": "Mobile Device Brand (Read-only)",
- "type": "string"
- },
- "buildNumber": {
- "description": "The device's operating system build number.",
- "type": "string"
- },
- "defaultLanguage": {
- "description": "The default locale used on the device.",
- "type": "string"
- },
- "developerOptionsStatus": {
- "description": "Developer options enabled or disabled on device (Read-only)",
- "type": "boolean"
- },
- "deviceCompromisedStatus": {
- "description": "The compromised device status.",
- "type": "string"
- },
- "deviceId": {
- "description": "The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.",
- "type": "string"
- },
- "devicePasswordStatus": {
- "description": "DevicePasswordStatus (Read-only)",
- "type": "string"
- },
- "email": {
- "description": "List of owner's email addresses. If your application needs the current list of user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](/admin-sdk/directory/v1/guides/manage-users#get_user) method.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "encryptionStatus": {
- "description": "Mobile Device Encryption Status (Read-only)",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "firstSync": {
- "description": "Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time",
- "type": "string"
- },
- "hardware": {
- "description": "Mobile Device Hardware (Read-only)",
- "type": "string"
- },
- "hardwareId": {
- "description": "The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.",
- "type": "string"
- },
- "imei": {
- "description": "The device's IMEI number.",
- "type": "string"
- },
- "kernelVersion": {
- "description": "The device's kernel version.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#mobiledevice",
- "description": "The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.",
- "type": "string"
- },
- "lastSync": {
- "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time",
- "type": "string"
- },
- "managedAccountIsOnOwnerProfile": {
- "description": "Boolean indicating if this account is on owner/primary profile or not.",
- "type": "boolean"
- },
- "manufacturer": {
- "description": "Mobile Device manufacturer (Read-only)",
- "type": "string"
- },
- "meid": {
- "description": "The device's MEID number.",
- "type": "string"
- },
- "model": {
- "description": "The mobile device's model name, for example Nexus S. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile=devices#update_mobile_device).",
- "type": "string"
- },
- "name": {
- "description": "List of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-users#get_user).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "networkOperator": {
- "description": "Mobile Device mobile or network operator (if available) (Read-only)",
- "type": "string"
- },
- "os": {
- "description": "The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).",
- "type": "string"
- },
- "otherAccountsInfo": {
- "description": "List of accounts added on device (Read-only)",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "privilege": {
- "description": "DMAgentPermission (Read-only)",
- "type": "string"
- },
- "releaseVersion": {
- "description": "Mobile Device release version version (Read-only)",
- "type": "string"
- },
- "resourceId": {
- "description": "The unique ID the API service uses to identify the mobile device.",
- "type": "string"
- },
- "securityPatchLevel": {
- "description": "Mobile Device Security patch level (Read-only)",
- "format": "int64",
- "type": "string"
- },
- "serialNumber": {
- "description": "The device's serial number.",
- "type": "string"
- },
- "status": {
- "description": "The device's status.",
- "type": "string"
- },
- "supportsWorkProfile": {
- "description": "Work profile supported on device (Read-only)",
- "type": "boolean"
- },
- "type": {
- "description": "The type of mobile device.",
- "type": "string"
- },
- "unknownSourcesStatus": {
- "description": "Unknown sources enabled or disabled on device (Read-only)",
- "type": "boolean"
- },
- "userAgent": {
- "description": "Gives information about the device such as `os` version. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).",
- "type": "string"
- },
- "wifiMacAddress": {
- "description": "The device's MAC address on Wi-Fi networks.",
- "type": "string"
- }
- },
- "type": "object"
+ "deskCode": {
+ "description": "Most specific textual code of individual desk location.",
+ "type": "string"
},
- "MobileDeviceAction": {
- "id": "MobileDeviceAction",
- "properties": {
- "action": {
- "annotations": {
- "required": [
- "directory.mobiledevices.action"
- ]
- },
- "description": "The action to be performed on the device.",
- "type": "string"
- }
- },
- "type": "object"
+ "floorName": {
+ "description": "Floor name/number.",
+ "type": "string"
},
- "MobileDevices": {
- "id": "MobileDevices",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#mobiledevices",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "mobiledevices": {
- "description": "List of Mobile Device objects.",
- "items": {
- "$ref": "MobileDevice"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Token used to access next page of this result.",
- "type": "string"
- }
- },
- "type": "object"
+ "floorSection": {
+ "description": "Floor section. More specific location within the floor. For example if a floor is divided into sections 'A', 'B' and 'C' this field would identify one of those values.",
+ "type": "string"
},
- "OrgUnit": {
- "description": "Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).",
- "id": "OrgUnit",
- "properties": {
- "blockInheritance": {
- "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).",
- "type": "boolean"
- },
- "description": {
- "description": "Description of the organizational unit.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#orgUnit",
- "description": "The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.",
- "type": "string"
- },
- "name": {
- "annotations": {
- "required": [
- "directory.orgunits.insert"
- ]
- },
- "description": "The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.",
- "type": "string"
- },
- "orgUnitId": {
- "description": "The unique ID of the organizational unit.",
- "type": "string"
- },
- "orgUnitPath": {
- "description": "The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).",
- "type": "string"
- },
- "parentOrgUnitId": {
- "description": "The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.",
- "type": "string"
- },
- "parentOrgUnitPath": {
- "description": "The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.",
- "type": "string"
- }
- },
- "type": "object"
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type an entry can have a custom type and can give it any name. Such types should have 'custom' as type and also have a customType value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserMakeAdmin": {
+ "id": "UserMakeAdmin",
+ "properties": {
+ "status": {
+ "annotations": {
+ "required": [
+ "directory.users.makeAdmin"
+ ]
+ },
+ "description": "Indicates the administrator status of the user.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "UserName": {
+ "id": "UserName",
+ "properties": {
+ "familyName": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "The user's last name. Required when creating a user account.",
+ "type": "string"
},
- "OrgUnits": {
- "id": "OrgUnits",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#orgUnits",
- "description": "The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.",
- "type": "string"
- },
- "organizationUnits": {
- "description": "List of organizational unit objects.",
- "items": {
- "$ref": "OrgUnit"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "fullName": {
+ "description": "The user's full name formed by concatenating the first and last name values.",
+ "type": "string"
},
- "Printer": {
- "description": "Printer configuration.",
- "id": "Printer",
- "properties": {
- "auxiliaryMessages": {
- "description": "Output only. Auxiliary messages about issues with the printer configuration if any.",
- "items": {
- "$ref": "AuxiliaryMessage"
- },
- "readOnly": true,
- "type": "array"
- },
- "createTime": {
- "description": "Output only. Time when printer was created.",
- "format": "google-datetime",
- "readOnly": true,
- "type": "string"
- },
- "description": {
- "description": "Editable. Description of printer.",
- "type": "string"
- },
- "displayName": {
- "description": "Editable. Name of printer.",
- "type": "string"
- },
- "id": {
- "description": "Id of the printer. (During printer creation leave empty)",
- "type": "string"
- },
- "makeAndModel": {
- "description": "Editable. Make and model of printer. e.g. Lexmark MS610de Value must be in format as seen in ListPrinterModels response.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)",
- "type": "string"
- },
- "orgUnitId": {
- "description": "Organization Unit that owns this printer (Only can be set during Printer creation)",
- "type": "string"
- },
- "uri": {
- "description": "Editable. Printer URI.",
- "type": "string"
- },
- "useDriverlessConfig": {
- "description": "Editable. flag to use driverless configuration or not. If it's set to be true, make_and_model can be ignored",
- "type": "boolean"
- }
- },
- "type": "object"
+ "givenName": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "The user's first name. Required when creating a user account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserOrganization": {
+ "description": "JSON template for an organization entry.",
+ "id": "UserOrganization",
+ "properties": {
+ "costCenter": {
+ "description": "The cost center of the users department.",
+ "type": "string"
},
- "PrinterModel": {
- "description": "Printer manufacturer and model",
- "id": "PrinterModel",
- "properties": {
- "displayName": {
- "description": "Display name. eq. \"Brother MFC-8840D\"",
- "type": "string"
- },
- "makeAndModel": {
- "description": "Make and model as represented in \"make_and_model\" field in Printer object. eq. \"brother mfc-8840d\"",
- "type": "string"
- },
- "manufacturer": {
- "description": "Manufacturer. eq. \"Brother\"",
- "type": "string"
- }
- },
- "type": "object"
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
},
- "Privilege": {
- "id": "Privilege",
- "properties": {
- "childPrivileges": {
- "description": "A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.",
- "items": {
- "$ref": "Privilege"
- },
- "type": "array"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "isOuScopable": {
- "description": "If the privilege can be restricted to an organization unit.",
- "type": "boolean"
- },
- "kind": {
- "default": "admin#directory#privilege",
- "description": "The type of the API resource. This is always `admin#directory#privilege`.",
- "type": "string"
- },
- "privilegeName": {
- "description": "The name of the privilege.",
- "type": "string"
- },
- "serviceId": {
- "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).",
- "type": "string"
- },
- "serviceName": {
- "description": "The name of the service this privilege is for.",
- "type": "string"
- }
- },
- "type": "object"
+ "department": {
+ "description": "Department within the organization.",
+ "type": "string"
},
- "Privileges": {
- "id": "Privileges",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of Privilege resources.",
- "items": {
- "$ref": "Privilege"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#privileges",
- "description": "The type of the API resource. This is always `admin#directory#privileges`.",
- "type": "string"
- }
- },
- "type": "object"
+ "description": {
+ "description": "Description of the organization.",
+ "type": "string"
},
- "RecentUsers": {
- "description": "List of recent device users, in descending order, by last login time.",
- "id": "RecentUsers",
- "properties": {
- "email": {
- "description": "The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.",
- "type": "string"
- },
- "type": {
- "description": "The type of the user.",
- "type": "string"
- }
- },
- "type": "object"
+ "domain": {
+ "description": "The domain to which the organization belongs to.",
+ "type": "string"
},
- "Role": {
- "id": "Role",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "isSuperAdminRole": {
- "description": "Returns `true` if the role is a super admin role.",
- "type": "boolean"
- },
- "isSystemRole": {
- "description": "Returns `true` if this is a pre-defined system role.",
- "type": "boolean"
- },
- "kind": {
- "default": "admin#directory#role",
- "description": "The type of the API resource. This is always `admin#directory#role`.",
- "type": "string"
- },
- "roleDescription": {
- "description": "A short description of the role.",
- "type": "string"
- },
- "roleId": {
- "description": "ID of the role.",
- "format": "int64",
- "type": "string"
- },
- "roleName": {
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- },
- "description": "Name of the role.",
- "type": "string"
- },
- "rolePrivileges": {
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- },
- "description": "The set of privileges that are granted to this role.",
- "items": {
- "properties": {
- "privilegeName": {
- "description": "The name of the privilege.",
- "type": "string"
- },
- "serviceId": {
- "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "fullTimeEquivalent": {
+ "description": "The full-time equivalent millipercent within the organization (100000 = 100%).",
+ "format": "int32",
+ "type": "integer"
},
- "RoleAssignment": {
- "id": "RoleAssignment",
- "properties": {
- "assignedTo": {
- "description": "The unique ID of the user this role is assigned to.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#roleAssignment",
- "description": "The type of the API resource. This is always `admin#directory#roleAssignment`.",
- "type": "string"
- },
- "orgUnitId": {
- "description": "If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.",
- "type": "string"
- },
- "roleAssignmentId": {
- "description": "ID of this roleAssignment.",
- "format": "int64",
- "type": "string"
- },
- "roleId": {
- "description": "The ID of the role that is assigned.",
- "format": "int64",
- "type": "string"
- },
- "scopeType": {
- "description": "The scope in which this role is assigned.",
- "type": "string"
- }
- },
- "type": "object"
+ "location": {
+ "description": "Location of the organization. This need not be fully qualified address.",
+ "type": "string"
},
- "RoleAssignments": {
- "id": "RoleAssignments",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of RoleAssignment resources.",
- "items": {
- "$ref": "RoleAssignment"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#roleAssignments",
- "description": "The type of the API resource. This is always `admin#directory#roleAssignments`.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string"
- }
- },
- "type": "object"
+ "name": {
+ "description": "Name of the organization",
+ "type": "string"
},
- "Roles": {
- "id": "Roles",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of Role resources.",
- "items": {
- "$ref": "Role"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#roles",
- "description": "The type of the API resource. This is always `admin#directory#roles`.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string"
- }
- },
- "type": "object"
+ "primary": {
+ "description": "If it user's primary organization.",
+ "type": "boolean"
},
- "Schema": {
- "description": "The type of API resource. For Schema resources, this is always `admin#directory#schema`.",
- "id": "Schema",
- "properties": {
- "displayName": {
- "annotations": {
- "required": [
- "directory.schemas.insert"
- ]
- },
- "description": "Display name for the schema.",
- "type": "string"
- },
- "etag": {
- "description": "The ETag of the resource.",
- "type": "string"
- },
- "fields": {
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- },
- "description": "A list of fields in the schema.",
- "items": {
- "$ref": "SchemaFieldSpec"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#schema",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "schemaId": {
- "description": "The unique identifier of the schema (Read-only)",
- "type": "string"
- },
- "schemaName": {
- "annotations": {
- "required": [
- "directory.schemas.insert"
- ]
- },
- "description": "The schema's name.",
- "type": "string"
- }
- },
- "type": "object"
+ "symbol": {
+ "description": "Symbol of the organization.",
+ "type": "string"
},
- "SchemaFieldSpec": {
- "description": "You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).",
- "id": "SchemaFieldSpec",
- "properties": {
- "displayName": {
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- },
- "description": "Display Name of the field.",
- "type": "string"
- },
- "etag": {
- "description": "The ETag of the field.",
- "type": "string"
- },
- "fieldId": {
- "description": "The unique identifier of the field (Read-only)",
- "type": "string"
- },
- "fieldName": {
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- },
- "description": "The name of the field.",
- "type": "string"
- },
- "fieldType": {
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- },
- "description": "The type of the field.",
- "type": "string"
- },
- "indexed": {
- "default": "true",
- "description": "Boolean specifying whether the field is indexed or not. Default: `true`.",
- "type": "boolean"
- },
- "kind": {
- "default": "admin#directory#schema#fieldspec",
- "description": "The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.",
- "type": "string"
- },
- "multiValued": {
- "description": "A boolean specifying whether this is a multi-valued field or not. Default: `false`.",
- "type": "boolean"
- },
- "numericIndexingSpec": {
- "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.",
- "properties": {
- "maxValue": {
- "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double",
- "type": "number"
- },
- "minValue": {
- "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "readAccessType": {
- "default": "ALL_DOMAIN_USERS",
- "description": "Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.",
- "type": "string"
- }
- },
- "type": "object"
+ "title": {
+ "description": "Title (designation) of the user in the organization.",
+ "type": "string"
},
- "Schemas": {
- "description": "JSON response template for List Schema operation in Directory API.",
- "id": "Schemas",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#schemas",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "schemas": {
- "description": "List of UserSchema objects.",
- "items": {
- "$ref": "Schema"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example organization could be of school work etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserPhone": {
+ "description": "JSON template for a phone entry.",
+ "id": "UserPhone",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
},
- "Token": {
- "description": "JSON template for token resource in Directory API.",
- "id": "Token",
- "properties": {
- "anonymous": {
- "description": "Whether the application is registered with Google. The value is `true` if the application has an anonymous Client ID.",
- "type": "boolean"
- },
- "clientId": {
- "description": "The Client ID of the application the token is issued to.",
- "type": "string"
- },
- "displayText": {
- "description": "The displayable name of the application the token is issued to.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#token",
- "description": "The type of the API resource. This is always `admin#directory#token`.",
- "type": "string"
- },
- "nativeApp": {
- "description": "Whether the token is issued to an installed application. The value is `true` if the application is installed to a desktop or mobile device.",
- "type": "boolean"
- },
- "scopes": {
- "description": "A list of authorization scopes the application is granted.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "userKey": {
- "description": "The unique ID of the user that issued the token.",
- "type": "string"
- }
- },
- "type": "object"
+ "primary": {
+ "description": "If this is user's primary phone or not.",
+ "type": "boolean"
},
- "Tokens": {
- "description": "JSON response template for List tokens operation in Directory API.",
- "id": "Tokens",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of Token resources.",
- "items": {
- "$ref": "Token"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#tokenList",
- "description": "The type of the API resource. This is always `admin#directory#tokenList`.",
- "type": "string"
- }
- },
- "type": "object"
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax work mobile etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Phone number.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserPhoto": {
+ "id": "UserPhoto",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "height": {
+ "description": "Height of the photo in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "The ID the API uses to uniquely identify the user.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#user#photo",
+ "description": "The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.",
+ "type": "string"
},
- "User": {
- "description": "The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).",
- "id": "User",
- "properties": {
- "addresses": {
- "description": "A list of the user's addresses. The maximum allowed data size for this field is 10Kb.",
- "type": "any"
- },
- "agreedToTerms": {
- "description": "Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.",
- "readOnly": true,
- "type": "boolean"
- },
- "aliases": {
- "description": "Output only. List of the user's alias email addresses.",
- "items": {
- "type": "string"
- },
- "readOnly": true,
- "type": "array"
- },
- "archived": {
- "description": "Indicates if user is archived.",
- "type": "boolean"
- },
- "changePasswordAtNextLogin": {
- "description": "Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224).",
- "type": "boolean"
- },
- "creationTime": {
- "description": "User's G Suite account creation time. (Read-only)",
- "format": "date-time",
- "readOnly": true,
- "type": "string"
- },
- "customSchemas": {
- "additionalProperties": {
- "$ref": "UserCustomProperties"
- },
- "description": "Custom fields of the user.",
- "type": "object"
- },
- "customerId": {
- "description": "Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.",
- "readOnly": true,
- "type": "string"
- },
- "deletionTime": {
- "format": "date-time",
- "readOnly": true,
- "type": "string"
- },
- "emails": {
- "description": "A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.",
- "type": "any"
- },
- "etag": {
- "description": "Output only. ETag of the resource.",
- "readOnly": true,
- "type": "string"
- },
- "externalIds": {
- "description": "A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.",
- "type": "any"
- },
- "gender": {
- "description": "The user's gender. The maximum allowed data size for this field is 1Kb.",
- "type": "any"
- },
- "hashFunction": {
- "description": "Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\\(C\\)) hash format.",
- "type": "string"
- },
- "id": {
- "description": "The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.",
- "type": "string"
- },
- "ims": {
- "description": "The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.",
- "type": "any"
- },
- "includeInGlobalAddressList": {
- "description": "Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).",
- "type": "boolean"
- },
- "ipWhitelisted": {
- "description": "If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).",
- "type": "boolean"
- },
- "isAdmin": {
- "description": "Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.",
- "readOnly": true,
- "type": "boolean"
- },
- "isDelegatedAdmin": {
- "description": "Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).",
- "readOnly": true,
- "type": "boolean"
- },
- "isEnforcedIn2Sv": {
- "description": "Output only. Is 2-step verification enforced (Read-only)",
- "readOnly": true,
- "type": "boolean"
- },
- "isEnrolledIn2Sv": {
- "description": "Output only. Is enrolled in 2-step verification (Read-only)",
- "readOnly": true,
- "type": "boolean"
- },
- "isMailboxSetup": {
- "description": "Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.",
- "readOnly": true,
- "type": "boolean"
- },
- "keywords": {
- "description": "The user's keywords. The maximum allowed data size for this field is 1Kb.",
- "type": "any"
- },
- "kind": {
- "default": "admin#directory#user",
- "description": "Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.",
- "readOnly": true,
- "type": "string"
- },
- "languages": {
- "description": "The user's languages. The maximum allowed data size for this field is 1Kb.",
- "type": "any"
- },
- "lastLoginTime": {
- "description": "User's last login time. (Read-only)",
- "format": "date-time",
- "readOnly": true,
- "type": "string"
- },
- "locations": {
- "description": "The user's locations. The maximum allowed data size for this field is 10Kb.",
- "type": "any"
- },
- "name": {
- "$ref": "UserName",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- },
- "description": "Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb."
- },
- "nonEditableAliases": {
- "description": "Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.",
- "items": {
- "type": "string"
- },
- "readOnly": true,
- "type": "array"
- },
- "notes": {
- "description": "Notes for the user.",
- "type": "any"
- },
- "orgUnitPath": {
- "description": "The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).",
- "type": "string"
- },
- "organizations": {
- "description": "A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.",
- "type": "any"
- },
- "password": {
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- },
- "description": "User's password",
- "type": "string"
- },
- "phones": {
- "description": "A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.",
- "type": "any"
- },
- "posixAccounts": {
- "description": "A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.",
- "type": "any"
- },
- "primaryEmail": {
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- },
- "description": "The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user.",
- "type": "string"
- },
- "recoveryEmail": {
- "description": "Recovery email of the user.",
- "type": "string"
- },
- "recoveryPhone": {
- "description": "Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*.",
- "type": "string"
- },
- "relations": {
- "description": "A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.",
- "type": "any"
- },
- "sshPublicKeys": {
- "description": "A list of SSH public keys.",
- "type": "any"
- },
- "suspended": {
- "description": "Indicates if user is suspended.",
- "type": "boolean"
- },
- "suspensionReason": {
- "description": "Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`.",
- "readOnly": true,
- "type": "string"
- },
- "thumbnailPhotoEtag": {
- "description": "Output only. ETag of the user's photo (Read-only)",
- "readOnly": true,
- "type": "string"
- },
- "thumbnailPhotoUrl": {
- "description": "Output only. Photo Url of the user (Read-only)",
- "readOnly": true,
- "type": "string"
- },
- "websites": {
- "description": "The user's websites. The maximum allowed data size for this field is 2Kb.",
- "type": "any"
- }
- },
- "type": "object"
+ "photoData": {
+ "annotations": {
+ "required": [
+ "directory.users.photos.update"
+ ]
+ },
+ "description": "The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.",
+ "format": "byte",
+ "type": "string"
},
- "UserAbout": {
- "description": "JSON template for About (notes) of a user in Directory API.",
- "id": "UserAbout",
- "properties": {
- "contentType": {
- "description": "About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text.",
- "type": "string"
- },
- "value": {
- "description": "Actual value of notes.",
- "type": "string"
- }
- },
- "type": "object"
+ "primaryEmail": {
+ "description": "The user's primary email address.",
+ "type": "string"
},
- "UserAddress": {
- "description": "JSON template for address.",
- "id": "UserAddress",
- "properties": {
- "country": {
- "description": "Country.",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code.",
- "type": "string"
- },
- "customType": {
- "description": "Custom type.",
- "type": "string"
- },
- "extendedAddress": {
- "description": "Extended Address.",
- "type": "string"
- },
- "formatted": {
- "description": "Formatted address.",
- "type": "string"
- },
- "locality": {
- "description": "Locality.",
- "type": "string"
- },
- "poBox": {
- "description": "Other parts of address.",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal code.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary address. Only one entry could be marked as primary.",
- "type": "boolean"
- },
- "region": {
- "description": "Region.",
- "type": "string"
- },
- "sourceIsStructured": {
- "description": "User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses but any values will eventually be clobbered.",
- "type": "boolean"
- },
- "streetAddress": {
- "description": "Street.",
- "type": "string"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard values of that entry. For example address could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- }
- },
- "type": "object"
+ "width": {
+ "description": "Width of the photo in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UserPosixAccount": {
+ "description": "JSON template for a POSIX account entry.",
+ "id": "UserPosixAccount",
+ "properties": {
+ "accountId": {
+ "description": "A POSIX account field identifier.",
+ "type": "string"
},
- "UserCustomProperties": {
- "additionalProperties": {
- "type": "any"
- },
- "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
- "id": "UserCustomProperties",
- "type": "object"
+ "gecos": {
+ "description": "The GECOS (user information) for this account.",
+ "type": "string"
},
- "UserEmail": {
- "description": "JSON template for an email.",
- "id": "UserEmail",
- "properties": {
- "address": {
- "description": "Email id of the user.",
- "type": "string"
- },
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary email. Only one entry could be marked as primary.",
- "type": "boolean"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- }
- },
- "type": "object"
+ "gid": {
+ "description": "The default group ID.",
+ "format": "uint64",
+ "type": "string"
},
- "UserExternalId": {
- "description": "JSON template for an externalId entry.",
- "id": "UserExternalId",
- "properties": {
- "customType": {
- "description": "Custom type.",
- "type": "string"
- },
- "type": {
- "description": "The type of the Id.",
- "type": "string"
- },
- "value": {
- "description": "The value of the id.",
- "type": "string"
- }
- },
- "type": "object"
+ "homeDirectory": {
+ "description": "The path to the home directory for this account.",
+ "type": "string"
},
- "UserGender": {
- "id": "UserGender",
- "properties": {
- "addressMeAs": {
- "description": "AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans for example he/him/his or they/them/their.",
- "type": "string"
- },
- "customGender": {
- "description": "Custom gender.",
- "type": "string"
- },
- "type": {
- "description": "Gender.",
- "type": "string"
- }
- },
- "type": "object"
+ "operatingSystemType": {
+ "description": "The operating system type for this account.",
+ "type": "string"
},
- "UserIm": {
- "description": "JSON template for instant messenger of an user.",
- "id": "UserIm",
- "properties": {
- "customProtocol": {
- "description": "Custom protocol.",
- "type": "string"
- },
- "customType": {
- "description": "Custom type.",
- "type": "string"
- },
- "im": {
- "description": "Instant messenger id.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary im. Only one entry could be marked as primary.",
- "type": "boolean"
- },
- "protocol": {
- "description": "Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type it can take a CUSTOM value and specify the custom name in customProtocol field.",
- "type": "string"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- }
- },
- "type": "object"
+ "primary": {
+ "description": "If this is user's primary account within the SystemId.",
+ "type": "boolean"
},
- "UserKeyword": {
- "description": "JSON template for a keyword entry.",
- "id": "UserKeyword",
- "properties": {
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard type of that entry. For example keyword could be of type occupation or outlook. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- },
- "value": {
- "description": "Keyword.",
- "type": "string"
- }
- },
- "type": "object"
+ "shell": {
+ "description": "The path to the login shell for this account.",
+ "type": "string"
},
- "UserLanguage": {
- "description": "JSON template for a language entry.",
- "id": "UserLanguage",
- "properties": {
- "customLanguage": {
- "description": "Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set",
- "type": "string"
- },
- "languageCode": {
- "description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.",
- "type": "string"
- }
- },
- "type": "object"
+ "systemId": {
+ "description": "System identifier for which account Username or Uid apply to.",
+ "type": "string"
},
- "UserLocation": {
- "description": "JSON template for a location entry.",
- "id": "UserLocation",
- "properties": {
- "area": {
- "description": "Textual location. This is most useful for display purposes to concisely describe the location. For example 'Mountain View, CA', 'Near Seattle', 'US-NYC-9TH 9A209A.''",
- "type": "string"
- },
- "buildingId": {
- "description": "Building Identifier.",
- "type": "string"
- },
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "deskCode": {
- "description": "Most specific textual code of individual desk location.",
- "type": "string"
- },
- "floorName": {
- "description": "Floor name/number.",
- "type": "string"
- },
- "floorSection": {
- "description": "Floor section. More specific location within the floor. For example if a floor is divided into sections 'A', 'B' and 'C' this field would identify one of those values.",
- "type": "string"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type an entry can have a custom type and can give it any name. Such types should have 'custom' as type and also have a customType value.",
- "type": "string"
- }
- },
- "type": "object"
+ "uid": {
+ "description": "The POSIX compliant user ID.",
+ "format": "uint64",
+ "type": "string"
},
- "UserMakeAdmin": {
- "id": "UserMakeAdmin",
- "properties": {
- "status": {
- "annotations": {
- "required": [
- "directory.users.makeAdmin"
- ]
- },
- "description": "Indicates the administrator status of the user.",
- "type": "boolean"
- }
- },
- "type": "object"
+ "username": {
+ "description": "The username of the account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRelation": {
+ "description": "JSON template for a relation entry.",
+ "id": "UserRelation",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
},
- "UserName": {
- "id": "UserName",
- "properties": {
- "familyName": {
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- },
- "description": "The user's last name. Required when creating a user account.",
- "type": "string"
- },
- "fullName": {
- "description": "The user's full name formed by concatenating the first and last name values.",
- "type": "string"
- },
- "givenName": {
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- },
- "description": "The user's first name. Required when creating a user account.",
- "type": "string"
- }
- },
- "type": "object"
+ "type": {
+ "description": "The relation of the user. Some of the possible values are mother father sister brother manager assistant partner.",
+ "type": "string"
},
- "UserOrganization": {
- "description": "JSON template for an organization entry.",
- "id": "UserOrganization",
- "properties": {
- "costCenter": {
- "description": "The cost center of the users department.",
- "type": "string"
- },
- "customType": {
- "description": "Custom type.",
- "type": "string"
- },
- "department": {
- "description": "Department within the organization.",
- "type": "string"
- },
- "description": {
- "description": "Description of the organization.",
- "type": "string"
- },
- "domain": {
- "description": "The domain to which the organization belongs to.",
- "type": "string"
- },
- "fullTimeEquivalent": {
- "description": "The full-time equivalent millipercent within the organization (100000 = 100%).",
- "format": "int32",
- "type": "integer"
- },
- "location": {
- "description": "Location of the organization. This need not be fully qualified address.",
- "type": "string"
- },
- "name": {
- "description": "Name of the organization",
- "type": "string"
- },
- "primary": {
- "description": "If it user's primary organization.",
- "type": "boolean"
- },
- "symbol": {
- "description": "Symbol of the organization.",
- "type": "string"
- },
- "title": {
- "description": "Title (designation) of the user in the organization.",
- "type": "string"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example organization could be of school work etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value.",
- "type": "string"
- }
- },
- "type": "object"
+ "value": {
+ "description": "The name of the relation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserSshPublicKey": {
+ "description": "JSON template for a POSIX account entry.",
+ "id": "UserSshPublicKey",
+ "properties": {
+ "expirationTimeUsec": {
+ "description": "An expiration time in microseconds since epoch.",
+ "format": "int64",
+ "type": "string"
},
- "UserPhone": {
- "description": "JSON template for a phone entry.",
- "id": "UserPhone",
- "properties": {
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary phone or not.",
- "type": "boolean"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax work mobile etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- },
- "value": {
- "description": "Phone number.",
- "type": "string"
- }
- },
- "type": "object"
+ "fingerprint": {
+ "description": "A SHA-256 fingerprint of the SSH public key. (Read-only)",
+ "readOnly": true,
+ "type": "string"
},
- "UserPhoto": {
- "id": "UserPhoto",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "height": {
- "description": "Height of the photo in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "The ID the API uses to uniquely identify the user.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#user#photo",
- "description": "The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.",
- "type": "string"
- },
- "photoData": {
- "annotations": {
- "required": [
- "directory.users.photos.update"
- ]
- },
- "description": "The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.",
- "format": "byte",
- "type": "string"
- },
- "primaryEmail": {
- "description": "The user's primary email address.",
- "type": "string"
- },
- "width": {
- "description": "Width of the photo in pixels.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
+ "key": {
+ "description": "An SSH public key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserUndelete": {
+ "id": "UserUndelete",
+ "properties": {
+ "orgUnitPath": {
+ "description": "OrgUnit of User",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserWebsite": {
+ "description": "JSON template for a website entry.",
+ "id": "UserWebsite",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
},
- "UserPosixAccount": {
- "description": "JSON template for a POSIX account entry.",
- "id": "UserPosixAccount",
- "properties": {
- "accountId": {
- "description": "A POSIX account field identifier.",
- "type": "string"
- },
- "gecos": {
- "description": "The GECOS (user information) for this account.",
- "type": "string"
- },
- "gid": {
- "description": "The default group ID.",
- "format": "uint64",
- "type": "string"
- },
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "operatingSystemType": {
- "description": "The operating system type for this account.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary account within the SystemId.",
- "type": "boolean"
- },
- "shell": {
- "description": "The path to the login shell for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account Username or Uid apply to.",
- "type": "string"
- },
- "uid": {
- "description": "The POSIX compliant user ID.",
- "format": "uint64",
- "type": "string"
- },
- "username": {
- "description": "The username of the account.",
- "type": "string"
- }
- },
- "type": "object"
+ "primary": {
+ "description": "If this is user's primary website or not.",
+ "type": "boolean"
},
- "UserRelation": {
- "description": "JSON template for a relation entry.",
- "id": "UserRelation",
- "properties": {
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "type": {
- "description": "The relation of the user. Some of the possible values are mother father sister brother manager assistant partner.",
- "type": "string"
- },
- "value": {
- "description": "The name of the relation.",
- "type": "string"
- }
- },
- "type": "object"
+ "type": {
+ "description": "Each entry can have a type which indicates standard types of that entry. For example website could be of home work blog etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
+ "type": "string"
},
- "UserSshPublicKey": {
- "description": "JSON template for a POSIX account entry.",
- "id": "UserSshPublicKey",
- "properties": {
- "expirationTimeUsec": {
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64",
- "type": "string"
- },
- "fingerprint": {
- "description": "A SHA-256 fingerprint of the SSH public key. (Read-only)",
- "readOnly": true,
- "type": "string"
- },
- "key": {
- "description": "An SSH public key.",
- "type": "string"
- }
- },
- "type": "object"
+ "value": {
+ "description": "Website.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Users": {
+ "id": "Users",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "UserUndelete": {
- "id": "UserUndelete",
- "properties": {
- "orgUnitPath": {
- "description": "OrgUnit of User",
- "type": "string"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#users",
+ "description": "Kind of resource this is.",
+ "type": "string"
},
- "UserWebsite": {
- "description": "JSON template for a website entry.",
- "id": "UserWebsite",
- "properties": {
- "customType": {
- "description": "Custom Type.",
- "type": "string"
- },
- "primary": {
- "description": "If this is user's primary website or not.",
- "type": "boolean"
- },
- "type": {
- "description": "Each entry can have a type which indicates standard types of that entry. For example website could be of home work blog etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.",
- "type": "string"
- },
- "value": {
- "description": "Website.",
- "type": "string"
- }
- },
- "type": "object"
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
},
- "Users": {
- "id": "Users",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#users",
- "description": "Kind of resource this is.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Token used to access next page of this result.",
- "type": "string"
- },
- "trigger_event": {
- "description": "Event that triggered this response (only used in case of Push Response)",
- "type": "string"
- },
- "users": {
- "description": "List of user objects.",
- "items": {
- "$ref": "User"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "trigger_event": {
+ "description": "Event that triggered this response (only used in case of Push Response)",
+ "type": "string"
},
- "VerificationCode": {
- "description": "The Directory API allows you to view, generate, and invalidate backup verification codes for a user.",
- "id": "VerificationCode",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#directory#verificationCode",
- "description": "The type of the resource. This is always `admin#directory#verificationCode`.",
- "type": "string"
- },
- "userId": {
- "description": "The obfuscated unique ID of the user.",
- "type": "string"
- },
- "verificationCode": {
- "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.",
- "type": "string"
- }
- },
- "type": "object"
+ "users": {
+ "description": "List of user objects.",
+ "items": {
+ "$ref": "User"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VerificationCode": {
+ "description": "The Directory API allows you to view, generate, and invalidate backup verification codes for a user.",
+ "id": "VerificationCode",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "VerificationCodes": {
- "description": "JSON response template for List verification codes operation in Directory API.",
- "id": "VerificationCodes",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of verification code resources.",
- "items": {
- "$ref": "VerificationCode"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#directory#verificationCodesList",
- "description": "The type of the resource. This is always `admin#directory#verificationCodesList`.",
- "type": "string"
- }
- },
- "type": "object"
+ "kind": {
+ "default": "admin#directory#verificationCode",
+ "description": "The type of the resource. This is always `admin#directory#verificationCode`.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The obfuscated unique ID of the user.",
+ "type": "string"
+ },
+ "verificationCode": {
+ "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "",
- "title": "Admin SDK API",
- "version": "directory_v1"
+ "VerificationCodes": {
+ "description": "JSON response template for List verification codes operation in Directory API.",
+ "id": "VerificationCodes",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of verification code resources.",
+ "items": {
+ "$ref": "VerificationCode"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#verificationCodesList",
+ "description": "The type of the resource. This is always `admin#directory#verificationCodesList`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Admin SDK API",
+ "version": "directory_v1"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json
index 3ad961d6b31..31ad23dc7a8 100644
--- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json
@@ -1,1080 +1,1084 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
- "description": "View audit reports for your G Suite domain"
- },
- "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
- "description": "View usage reports for your G Suite domain"
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
+ "description": "View audit reports for your G Suite domain"
+ },
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
+ "description": "View usage reports for your G Suite domain"
}
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://admin.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "reports",
+ "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
+ "discoveryVersion": "v1",
+ "documentationLink": "http://developers.google.com/admin-sdk/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "admin:reports_v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "basePath": "",
- "baseUrl": "https://admin.googleapis.com/",
- "batchPath": "batch",
- "canonicalName": "reports",
- "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
- "discoveryVersion": "v1",
- "documentationLink": "http://developers.google.com/admin-sdk/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
- "id": "admin:reports_v1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://admin.mtls.googleapis.com/",
- "name": "admin",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "activities": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. ",
+ "flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
+ "httpMethod": "GET",
+ "id": "reports.activities.list",
+ "parameterOrder": [
+ "userKey",
+ "applicationName"
+ ],
+ "parameters": {
+ "actorIpAddress": {
+ "description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
+ "location": "query",
+ "type": "string"
+ },
+ "applicationName": {
+ "description": "Application name for which the events are to be retrieved.",
+ "enum": [
+ "access_transparency",
+ "admin",
+ "calendar",
+ "chat",
+ "drive",
+ "gcp",
+ "gplus",
+ "groups",
+ "groups_enterprise",
+ "jamboard",
+ "login",
+ "meet",
+ "mobile",
+ "rules",
+ "saml",
+ "token",
+ "user_accounts",
+ "context_aware_access",
+ "chrome",
+ "data_studio",
+ "keep"
+ ],
+ "enumDescriptions": [
+ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
+ "The Admin console application's activity reports return account information about different types of administrator activity events.",
+ "The Google Calendar application's activity reports return information about various Calendar activity events.",
+ "The Chat activity reports return information about various Chat activity events.",
+ "The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Enterprise customers.",
+ "The Google Cloud Platform application's activity reports return information about various GCP activity events.",
+ "The Google+ application's activity reports return information about various Google+ activity events.",
+ "The Google Groups application's activity reports return information about various Groups activity events.",
+ "The Enterprise Groups activity reports return information about various Enterprise group activity events.",
+ "The Jamboard activity reports return information about various Jamboard activity events.",
+ "The Login application's activity reports return account information about different types of Login activity events.",
+ "The Meet Audit activity report return information about different types of Meet Audit activity events.",
+ "The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
+ "The Rules activity report return information about different types of Rules activity events.",
+ "The SAML activity report return information about different types of SAML activity events.",
+ "The Token application's activity reports return account information about different types of Token activity events.",
+ "The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
+ "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
+ "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
+ "The Data Studio activity reports return information about various types of Data Studio activity events.",
+ "The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers."
+ ],
+ "location": "path",
+ "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
+ "required": true,
+ "type": "string"
+ },
+ "customerId": {
+ "description": "The unique ID of the customer to retrieve data for.",
+ "location": "query",
+ "pattern": "C.+|my_customer",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "eventName": {
+ "description": "The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.",
+ "location": "query",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ",
+ "location": "query",
+ "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
+ "type": "string"
+ },
+ "groupIdFilter": {
+ "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orgUnitID": {
+ "default": "",
+ "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+)",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
+ "location": "query",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
+ "response": {
+ "$ref": "Activities"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ]
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "watch": {
+ "description": "Start receiving notifications for account activities. For more information, see Receiving Push Notifications.",
+ "flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
+ "httpMethod": "POST",
+ "id": "reports.activities.watch",
+ "parameterOrder": [
+ "userKey",
+ "applicationName"
+ ],
+ "parameters": {
+ "actorIpAddress": {
+ "description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
+ "location": "query",
+ "type": "string"
+ },
+ "applicationName": {
+ "description": "Application name for which the events are to be retrieved.",
+ "enum": [
+ "access_transparency",
+ "admin",
+ "calendar",
+ "chat",
+ "drive",
+ "gcp",
+ "gplus",
+ "groups",
+ "groups_enterprise",
+ "jamboard",
+ "login",
+ "meet",
+ "mobile",
+ "rules",
+ "saml",
+ "token",
+ "user_accounts",
+ "context_aware_access",
+ "chrome",
+ "data_studio",
+ "keep"
+ ],
+ "enumDescriptions": [
+ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
+ "The Admin console application's activity reports return account information about different types of administrator activity events.",
+ "The Google Calendar application's activity reports return information about various Calendar activity events.",
+ "The Chat activity reports return information about various Chat activity events.",
+ "The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Google Workspace Enterprise customers.",
+ "The Google Cloud Platform application's activity reports return information about various GCP activity events.",
+ "The Google+ application's activity reports return information about various Google+ activity events.",
+ "The Google Groups application's activity reports return information about various Groups activity events.",
+ "The Enterprise Groups activity reports return information about various Enterprise group activity events.",
+ "The Jamboard activity reports return information about various Jamboard activity events.",
+ "The Login application's activity reports return account information about different types of Login activity events.",
+ "The Meet Audit activity report return information about different types of Meet Audit activity events.",
+ "The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
+ "The Rules activity report return information about different types of Rules activity events.",
+ "The SAML activity report return information about different types of SAML activity events.",
+ "The Token application's activity reports return account information about different types of Token activity events.",
+ "The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
+ "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
+ "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
+ "The Data Studio activity reports return information about various types of Data Studio activity events.",
+ "The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers."
+ ],
+ "location": "path",
+ "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
+ "required": true,
+ "type": "string"
+ },
+ "customerId": {
+ "description": "The unique ID of the customer to retrieve data for.",
+ "location": "query",
+ "pattern": "C.+|my_customer",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "eventName": {
+ "description": "The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.",
+ "location": "query",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ",
+ "location": "query",
+ "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
+ "type": "string"
+ },
+ "groupIdFilter": {
+ "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orgUnitID": {
+ "default": "",
+ "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+)",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
+ "location": "query",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
+ "request": {
+ "$ref": "Channel"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ]
}
+ }
},
- "protocol": "rest",
- "resources": {
- "activities": {
- "methods": {
- "list": {
- "description": "Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. ",
- "flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
- "httpMethod": "GET",
- "id": "reports.activities.list",
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "parameters": {
- "actorIpAddress": {
- "description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
- "location": "query",
- "type": "string"
- },
- "applicationName": {
- "description": "Application name for which the events are to be retrieved.",
- "enum": [
- "access_transparency",
- "admin",
- "calendar",
- "chat",
- "drive",
- "gcp",
- "gplus",
- "groups",
- "groups_enterprise",
- "jamboard",
- "login",
- "meet",
- "mobile",
- "rules",
- "saml",
- "token",
- "user_accounts",
- "context_aware_access",
- "chrome",
- "data_studio"
- ],
- "enumDescriptions": [
- "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
- "The Admin console application's activity reports return account information about different types of administrator activity events.",
- "The Google Calendar application's activity reports return information about various Calendar activity events.",
- "The Chat activity reports return information about various Chat activity events.",
- "The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Enterprise customers.",
- "The Google Cloud Platform application's activity reports return information about various GCP activity events.",
- "The Google+ application's activity reports return information about various Google+ activity events.",
- "The Google Groups application's activity reports return information about various Groups activity events.",
- "The Enterprise Groups activity reports return information about various Enterprise group activity events.",
- "The Jamboard activity reports return information about various Jamboard activity events.",
- "The Login application's activity reports return account information about different types of Login activity events.",
- "The Meet Audit activity report return information about different types of Meet Audit activity events.",
- "The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
- "The Rules activity report return information about different types of Rules activity events.",
- "The SAML activity report return information about different types of SAML activity events.",
- "The Token application's activity reports return account information about different types of Token activity events.",
- "The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
- "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
- "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
- "The Data Studio activity reports return information about various types of Data Studio activity events."
- ],
- "location": "path",
- "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
- "required": true,
- "type": "string"
- },
- "customerId": {
- "description": "The unique ID of the customer to retrieve data for.",
- "location": "query",
- "pattern": "C.+|my_customer",
- "type": "string"
- },
- "endTime": {
- "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.",
- "location": "query",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "type": "string"
- },
- "eventName": {
- "description": "The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.",
- "location": "query",
- "type": "string"
- },
- "filters": {
- "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ",
- "location": "query",
- "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
- "type": "string"
- },
- "groupIdFilter": {
- "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
- "location": "query",
- "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "1",
- "type": "integer"
- },
- "orgUnitID": {
- "default": "",
- "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
- "location": "query",
- "pattern": "(id:[a-z0-9]+)",
- "type": "string"
- },
- "pageToken": {
- "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
- "location": "query",
- "type": "string"
- },
- "startTime": {
- "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.",
- "location": "query",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "type": "string"
- },
- "userKey": {
- "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
- "response": {
- "$ref": "Activities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ]
- },
- "watch": {
- "description": "Start receiving notifications for account activities. For more information, see Receiving Push Notifications.",
- "flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
- "httpMethod": "POST",
- "id": "reports.activities.watch",
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "parameters": {
- "actorIpAddress": {
- "description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
- "location": "query",
- "type": "string"
- },
- "applicationName": {
- "description": "Application name for which the events are to be retrieved.",
- "enum": [
- "access_transparency",
- "admin",
- "calendar",
- "chat",
- "drive",
- "gcp",
- "gplus",
- "groups",
- "groups_enterprise",
- "jamboard",
- "login",
- "meet",
- "mobile",
- "rules",
- "saml",
- "token",
- "user_accounts",
- "context_aware_access",
- "chrome",
- "data_studio"
- ],
- "enumDescriptions": [
- "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
- "The Admin console application's activity reports return account information about different types of administrator activity events.",
- "The Google Calendar application's activity reports return information about various Calendar activity events.",
- "The Chat activity reports return information about various Chat activity events.",
- "The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Google Workspace Enterprise customers.",
- "The Google Cloud Platform application's activity reports return information about various GCP activity events.",
- "The Google+ application's activity reports return information about various Google+ activity events.",
- "The Google Groups application's activity reports return information about various Groups activity events.",
- "The Enterprise Groups activity reports return information about various Enterprise group activity events.",
- "The Jamboard activity reports return information about various Jamboard activity events.",
- "The Login application's activity reports return account information about different types of Login activity events.",
- "The Meet Audit activity report return information about different types of Meet Audit activity events.",
- "The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
- "The Rules activity report return information about different types of Rules activity events.",
- "The SAML activity report return information about different types of SAML activity events.",
- "The Token application's activity reports return account information about different types of Token activity events.",
- "The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
- "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
- "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
- "The Data Studio activity reports return information about various types of Data Studio activity events."
- ],
- "location": "path",
- "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
- "required": true,
- "type": "string"
- },
- "customerId": {
- "description": "The unique ID of the customer to retrieve data for.",
- "location": "query",
- "pattern": "C.+|my_customer",
- "type": "string"
- },
- "endTime": {
- "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.",
- "location": "query",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "type": "string"
- },
- "eventName": {
- "description": "The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.",
- "location": "query",
- "type": "string"
- },
- "filters": {
- "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ",
- "location": "query",
- "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
- "type": "string"
- },
- "groupIdFilter": {
- "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
- "location": "query",
- "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "1",
- "type": "integer"
- },
- "orgUnitID": {
- "default": "",
- "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
- "location": "query",
- "pattern": "(id:[a-z0-9]+)",
- "type": "string"
- },
- "pageToken": {
- "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
- "location": "query",
- "type": "string"
- },
- "startTime": {
- "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.",
- "location": "query",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "type": "string"
- },
- "userKey": {
- "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
- "request": {
- "$ref": "Channel"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ]
- }
+ "channels": {
+ "methods": {
+ "stop": {
+ "description": "Stop watching resources through this channel.",
+ "flatPath": "admin/reports_v1/channels/stop",
+ "httpMethod": "POST",
+ "id": "admin.channels.stop",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "admin/reports_v1/channels/stop",
+ "request": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ]
+ }
+ }
+ },
+ "customerUsageReports": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides. ",
+ "flatPath": "admin/reports/v1/usage/dates/{date}",
+ "httpMethod": "GET",
+ "id": "reports.customerUsageReports.get",
+ "parameterOrder": [
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID of the customer to retrieve data for.",
+ "location": "query",
+ "pattern": "C.+|my_customer",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
+ "location": "query",
+ "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
+ "type": "string"
}
- },
- "channels": {
- "methods": {
- "stop": {
- "description": "Stop watching resources through this channel.",
- "flatPath": "admin/reports_v1/channels/stop",
- "httpMethod": "POST",
- "id": "admin.channels.stop",
- "parameterOrder": [],
- "parameters": {},
- "path": "admin/reports_v1/channels/stop",
- "request": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ]
- }
+ },
+ "path": "admin/reports/v1/usage/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ },
+ "entityUsageReports": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.",
+ "flatPath": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
+ "httpMethod": "GET",
+ "id": "reports.entityUsageReports.get",
+ "parameterOrder": [
+ "entityType",
+ "entityKey",
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID of the customer to retrieve data for.",
+ "location": "query",
+ "pattern": "C.+|my_customer",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "entityKey": {
+ "description": "Represents the key of the object to filter the data with.",
+ "enum": [
+ "all",
+ "entityKey"
+ ],
+ "enumDescriptions": [
+ "Returns activity events for all users.",
+ "Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides."
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entityType": {
+ "description": "Represents the type of entity for the report.",
+ "enum": [
+ "gplus_communities"
+ ],
+ "enumDescriptions": [
+ "Returns a report on Google+ communities."
+ ],
+ "location": "path",
+ "pattern": "(gplus_communities)",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.",
+ "location": "query",
+ "pattern": "(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
+ "location": "query",
+ "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
+ "type": "string"
}
- },
- "customerUsageReports": {
- "methods": {
- "get": {
- "description": "Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides. ",
- "flatPath": "admin/reports/v1/usage/dates/{date}",
- "httpMethod": "GET",
- "id": "reports.customerUsageReports.get",
- "parameterOrder": [
- "date"
- ],
- "parameters": {
- "customerId": {
- "description": "The unique ID of the customer to retrieve data for.",
- "location": "query",
- "pattern": "C.+|my_customer",
- "type": "string"
- },
- "date": {
- "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
- "location": "path",
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.",
- "location": "query",
- "type": "string"
- },
- "parameters": {
- "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
- "location": "query",
- "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
- "type": "string"
- }
- },
- "path": "admin/reports/v1/usage/dates/{date}",
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
+ },
+ "path": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ },
+ "userUsageReport": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.",
+ "flatPath": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
+ "httpMethod": "GET",
+ "id": "reports.userUsageReport.get",
+ "parameterOrder": [
+ "userKey",
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "The unique ID of the customer to retrieve data for.",
+ "location": "query",
+ "pattern": "C.+|my_customer",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ",
+ "location": "query",
+ "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
+ "type": "string"
+ },
+ "groupIdFilter": {
+ "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orgUnitID": {
+ "default": "",
+ "description": "ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
+ "location": "query",
+ "pattern": "(id:[a-z0-9]+)",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
+ "location": "query",
+ "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210511",
+ "rootUrl": "https://admin.googleapis.com/",
+ "schemas": {
+ "Activities": {
+ "description": "JSON template for a collection of activities.",
+ "id": "Activities",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "entityUsageReports": {
- "methods": {
- "get": {
- "description": "Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.",
- "flatPath": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
- "httpMethod": "GET",
- "id": "reports.entityUsageReports.get",
- "parameterOrder": [
- "entityType",
- "entityKey",
- "date"
- ],
- "parameters": {
- "customerId": {
- "description": "The unique ID of the customer to retrieve data for.",
- "location": "query",
- "pattern": "C.+|my_customer",
- "type": "string"
- },
- "date": {
- "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
- "location": "path",
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "required": true,
- "type": "string"
- },
- "entityKey": {
- "description": "Represents the key of the object to filter the data with.",
- "enum": [
- "all",
- "entityKey"
- ],
- "enumDescriptions": [
- "Returns activity events for all users.",
- "Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides."
- ],
- "location": "path",
- "required": true,
- "type": "string"
- },
- "entityType": {
- "description": "Represents the type of entity for the report.",
- "enum": [
- "gplus_communities"
- ],
- "enumDescriptions": [
- "Returns a report on Google+ communities."
- ],
- "location": "path",
- "pattern": "(gplus_communities)",
- "required": true,
- "type": "string"
- },
- "filters": {
- "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.",
- "location": "query",
- "pattern": "(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page.",
- "format": "uint32",
- "location": "query",
- "maximum": "1000",
- "minimum": "1",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
- "location": "query",
- "type": "string"
- },
- "parameters": {
- "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
- "location": "query",
- "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
- "type": "string"
- }
- },
- "path": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
+ "items": {
+ "description": "Each activity record in the response.",
+ "items": {
+ "$ref": "Activity"
+ },
+ "type": "array"
},
- "userUsageReport": {
- "methods": {
- "get": {
- "description": "Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.",
- "flatPath": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
- "httpMethod": "GET",
- "id": "reports.userUsageReport.get",
- "parameterOrder": [
- "userKey",
- "date"
- ],
- "parameters": {
- "customerId": {
- "description": "The unique ID of the customer to retrieve data for.",
- "location": "query",
- "pattern": "C.+|my_customer",
- "type": "string"
- },
- "date": {
- "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
- "location": "path",
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "required": true,
- "type": "string"
- },
- "filters": {
- "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ",
- "location": "query",
- "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
- "type": "string"
- },
- "groupIdFilter": {
- "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
- "location": "query",
- "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional.",
- "format": "uint32",
- "location": "query",
- "maximum": "1000",
- "minimum": "1",
- "type": "integer"
- },
- "orgUnitID": {
- "default": "",
- "description": "ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
- "location": "query",
- "pattern": "(id:[a-z0-9]+)",
- "type": "string"
- },
- "pageToken": {
- "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.",
- "location": "query",
- "type": "string"
- },
- "parameters": {
- "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
- "location": "query",
- "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
- "type": "string"
- },
- "userKey": {
- "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
+ "kind": {
+ "default": "admin#reports#activities",
+ "description": "The type of API resource. For an activity report, the value is `reports#activities`.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string.",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "revision": "20210323",
- "rootUrl": "https://admin.googleapis.com/",
- "schemas": {
- "Activities": {
- "description": "JSON template for a collection of activities.",
- "id": "Activities",
- "properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "items": {
- "description": "Each activity record in the response.",
- "items": {
- "$ref": "Activity"
- },
- "type": "array"
- },
- "kind": {
- "default": "admin#reports#activities",
- "description": "The type of API resource. For an activity report, the value is `reports#activities`.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string.",
- "type": "string"
- }
+ "Activity": {
+ "description": "JSON template for the activity resource.",
+ "id": "Activity",
+ "properties": {
+ "actor": {
+ "description": "User doing the action.",
+ "properties": {
+ "callerType": {
+ "description": "The type of actor.",
+ "type": "string"
},
- "type": "object"
+ "email": {
+ "description": "The primary email address of the actor. May be absent if there is no email address associated with the actor.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The unique Google Workspace profile ID of the actor. May be absent if the actor is not a Google Workspace user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "Activity": {
- "description": "JSON template for the activity resource.",
- "id": "Activity",
+ "etag": {
+ "description": "ETag of the entry.",
+ "type": "string"
+ },
+ "events": {
+ "description": "Activity events in the report.",
+ "items": {
"properties": {
- "actor": {
- "description": "User doing the action.",
- "properties": {
- "callerType": {
- "description": "The type of actor.",
- "type": "string"
- },
- "email": {
- "description": "The primary email address of the actor. May be absent if there is no email address associated with the actor.",
- "type": "string"
- },
- "key": {
- "description": "Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.",
- "type": "string"
- },
- "profileId": {
- "description": "The unique Google Workspace profile ID of the actor. May be absent if the actor is not a Google Workspace user.",
- "type": "string"
+ "name": {
+ "description": "Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`.",
+ "items": {
+ "properties": {
+ "boolValue": {
+ "description": "Boolean value of the parameter.",
+ "type": "boolean"
+ },
+ "intValue": {
+ "description": "Integer value of the parameter.",
+ "format": "int64",
+ "type": "string"
+ },
+ "messageValue": {
+ "description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`",
+ "properties": {
+ "parameter": {
+ "description": "Parameter values",
+ "items": {
+ "$ref": "NestedParameter"
+ },
+ "type": "array"
}
+ },
+ "type": "object"
},
- "type": "object"
- },
- "etag": {
- "description": "ETag of the entry.",
- "type": "string"
- },
- "events": {
- "description": "Activity events in the report.",
- "items": {
+ "multiIntValue": {
+ "description": "Integer values of the parameter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "multiMessageValue": {
+ "description": "List of `messageValue` objects.",
+ "items": {
"properties": {
- "name": {
- "description": "Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`.",
- "items": {
- "properties": {
- "boolValue": {
- "description": "Boolean value of the parameter.",
- "type": "boolean"
- },
- "intValue": {
- "description": "Integer value of the parameter.",
- "format": "int64",
- "type": "string"
- },
- "messageValue": {
- "description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`",
- "properties": {
- "parameter": {
- "description": "Parameter values",
- "items": {
- "$ref": "NestedParameter"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "multiIntValue": {
- "description": "Integer values of the parameter.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "multiMessageValue": {
- "description": "List of `messageValue` objects.",
- "items": {
- "properties": {
- "parameter": {
- "description": "Parameter values",
- "items": {
- "$ref": "NestedParameter"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "multiValue": {
- "description": "String values of the parameter.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the parameter.",
- "type": "string"
- },
- "value": {
- "description": "String value of the parameter.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "parameter": {
+ "description": "Parameter values",
+ "items": {
+ "$ref": "NestedParameter"
},
- "type": {
- "description": "Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.",
- "type": "string"
- }
+ "type": "array"
+ }
},
"type": "object"
+ },
+ "type": "array"
},
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for each activity record.",
- "properties": {
- "applicationName": {
- "description": "Application name to which the event belongs. For possible values see the list of applications above in `applicationName`.",
- "type": "string"
- },
- "customerId": {
- "description": "The unique identifier for a Google Workspace account.",
- "type": "string"
- },
- "time": {
- "description": "Time of occurrence of the activity. This is in UNIX epoch time in seconds.",
- "format": "date-time",
- "type": "string"
- },
- "uniqueQualifier": {
- "description": "Unique qualifier if multiple events have the same time.",
- "format": "int64",
- "type": "string"
- }
+ "multiValue": {
+ "description": "String values of the parameter.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ipAddress": {
- "description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.",
- "type": "string"
- },
- "kind": {
- "default": "admin#reports#activity",
- "description": "The type of API resource. For an activity report, the value is `audit#activity`.",
- "type": "string"
+ "name": {
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "String value of the parameter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "ownerDomain": {
- "description": "This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.",
- "type": "string"
- }
+ "type": "array"
+ },
+ "type": {
+ "description": "Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.",
+ "type": "string"
+ }
},
"type": "object"
+ },
+ "type": "array"
},
- "Channel": {
- "description": "A notification channel used to watch for resource changes.",
- "id": "Channel",
- "properties": {
- "address": {
- "description": "The address where notifications are delivered for this channel.",
- "type": "string"
- },
- "expiration": {
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "A UUID or similar unique string that identifies this channel.",
- "type": "string"
- },
- "kind": {
- "default": "api#channel",
- "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"`api#channel`\".",
- "type": "string"
- },
- "params": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "type": "object"
- },
- "payload": {
- "description": "A Boolean value to indicate whether payload is wanted. Optional.",
- "type": "boolean"
- },
- "resourceId": {
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
- "type": "string"
- },
- "resourceUri": {
- "description": "A version-specific identifier for the watched resource.",
- "type": "string"
- },
- "token": {
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
- "type": "string"
- },
- "type": {
- "description": "The type of delivery mechanism used for this channel. The value should be set to `\"web_hook\"`.",
- "type": "string"
- }
+ "id": {
+ "description": "Unique identifier for each activity record.",
+ "properties": {
+ "applicationName": {
+ "description": "Application name to which the event belongs. For possible values see the list of applications above in `applicationName`.",
+ "type": "string"
},
- "type": "object"
+ "customerId": {
+ "description": "The unique identifier for a Google Workspace account.",
+ "type": "string"
+ },
+ "time": {
+ "description": "Time of occurrence of the activity. This is in UNIX epoch time in seconds.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "uniqueQualifier": {
+ "description": "Unique qualifier if multiple events have the same time.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "NestedParameter": {
- "description": "JSON template for a parameter used in various reports.",
- "id": "NestedParameter",
- "properties": {
- "boolValue": {
- "description": "Boolean value of the parameter.",
- "type": "boolean"
- },
- "intValue": {
- "description": "Integer value of the parameter.",
- "format": "int64",
- "type": "string"
- },
- "multiBoolValue": {
- "description": "Multiple boolean values of the parameter.",
- "items": {
- "type": "boolean"
- },
- "type": "array"
- },
- "multiIntValue": {
- "description": "Multiple integer values of the parameter.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "multiValue": {
- "description": "Multiple string values of the parameter.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the parameter.",
- "type": "string"
- },
- "value": {
- "description": "String value of the parameter.",
- "type": "string"
- }
+ "ipAddress": {
+ "description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#reports#activity",
+ "description": "The type of API resource. For an activity report, the value is `audit#activity`.",
+ "type": "string"
+ },
+ "ownerDomain": {
+ "description": "This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Channel": {
+ "description": "A notification channel used to watch for resource changes.",
+ "id": "Channel",
+ "properties": {
+ "address": {
+ "description": "The address where notifications are delivered for this channel.",
+ "type": "string"
+ },
+ "expiration": {
+ "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "A UUID or similar unique string that identifies this channel.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "api#channel",
+ "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"`api#channel`\".",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Additional parameters controlling delivery channel behavior. Optional.",
+ "type": "object"
+ },
+ "payload": {
+ "description": "A Boolean value to indicate whether payload is wanted. Optional.",
+ "type": "boolean"
+ },
+ "resourceId": {
+ "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "A version-specific identifier for the watched resource.",
+ "type": "string"
+ },
+ "token": {
+ "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of delivery mechanism used for this channel. The value should be set to `\"web_hook\"`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NestedParameter": {
+ "description": "JSON template for a parameter used in various reports.",
+ "id": "NestedParameter",
+ "properties": {
+ "boolValue": {
+ "description": "Boolean value of the parameter.",
+ "type": "boolean"
+ },
+ "intValue": {
+ "description": "Integer value of the parameter.",
+ "format": "int64",
+ "type": "string"
+ },
+ "multiBoolValue": {
+ "description": "Multiple boolean values of the parameter.",
+ "items": {
+ "type": "boolean"
+ },
+ "type": "array"
+ },
+ "multiIntValue": {
+ "description": "Multiple integer values of the parameter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "multiValue": {
+ "description": "Multiple string values of the parameter.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "String value of the parameter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UsageReport": {
+ "description": "JSON template for a usage report.",
+ "id": "UsageReport",
+ "properties": {
+ "date": {
+ "description": "Output only. The date of the report request.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "entity": {
+ "description": "Output only. Information about the type of the item.",
+ "properties": {
+ "customerId": {
+ "description": "Output only. The unique identifier of the customer's account.",
+ "readOnly": true,
+ "type": "string"
},
- "type": "object"
+ "entityId": {
+ "description": "Output only. Object key. Only relevant if entity.type = \"OBJECT\" Note: external-facing name of report is \"Entities\" rather than \"Objects\".",
+ "readOnly": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Output only. The user's immutable Google Workspace profile identifier.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Output only. The type of item. The value is `user`.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "userEmail": {
+ "description": "Output only. The user's email address. Only relevant if entity.type = \"USER\"",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "readOnly": true,
+ "type": "object"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "UsageReport": {
- "description": "JSON template for a usage report.",
- "id": "UsageReport",
+ "kind": {
+ "default": "admin#reports#usageReport",
+ "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReport`.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).",
+ "items": {
"properties": {
- "date": {
- "description": "Output only. The date of the report request.",
- "readOnly": true,
- "type": "string"
- },
- "entity": {
- "description": "Output only. Information about the type of the item.",
- "properties": {
- "customerId": {
- "description": "Output only. The unique identifier of the customer's account.",
- "readOnly": true,
- "type": "string"
- },
- "entityId": {
- "description": "Output only. Object key. Only relevant if entity.type = \"OBJECT\" Note: external-facing name of report is \"Entities\" rather than \"Objects\".",
- "readOnly": true,
- "type": "string"
- },
- "profileId": {
- "description": "Output only. The user's immutable Google Workspace profile identifier.",
- "readOnly": true,
- "type": "string"
- },
- "type": {
- "description": "Output only. The type of item. The value is `user`.",
- "readOnly": true,
- "type": "string"
- },
- "userEmail": {
- "description": "Output only. The user's email address. Only relevant if entity.type = \"USER\"",
- "readOnly": true,
- "type": "string"
- }
- },
- "readOnly": true,
- "type": "object"
- },
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#reports#usageReport",
- "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReport`.",
- "type": "string"
+ "boolValue": {
+ "description": "Output only. Boolean value of the parameter.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "datetimeValue": {
+ "description": "The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "intValue": {
+ "description": "Output only. Integer value of the parameter.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "msgValue": {
+ "description": "Output only. Nested message value of the parameter.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "type": "object"
},
- "parameters": {
- "description": "Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).",
- "items": {
- "properties": {
- "boolValue": {
- "description": "Output only. Boolean value of the parameter.",
- "readOnly": true,
- "type": "boolean"
- },
- "datetimeValue": {
- "description": "The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.",
- "format": "date-time",
- "readOnly": true,
- "type": "string"
- },
- "intValue": {
- "description": "Output only. Integer value of the parameter.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "msgValue": {
- "description": "Output only. Nested message value of the parameter.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "type": "object"
- },
- "readOnly": true,
- "type": "array"
- },
- "name": {
- "description": "The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference.",
- "type": "string"
- },
- "stringValue": {
- "description": "Output only. String value of the parameter.",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "readOnly": true,
- "type": "array"
- }
+ "readOnly": true,
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference.",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "Output only. String value of the parameter.",
+ "readOnly": true,
+ "type": "string"
+ }
},
"type": "object"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UsageReports": {
+ "id": "UsageReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#reports#usageReports",
+ "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReports`.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.",
+ "type": "string"
},
- "UsageReports": {
- "id": "UsageReports",
+ "usageReports": {
+ "description": "Various application parameter records.",
+ "items": {
+ "$ref": "UsageReport"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Warnings, if any.",
+ "items": {
"properties": {
- "etag": {
- "description": "ETag of the resource.",
- "type": "string"
- },
- "kind": {
- "default": "admin#reports#usageReports",
- "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReports`.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.",
- "type": "string"
- },
- "usageReports": {
- "description": "Various application parameter records.",
- "items": {
- "$ref": "UsageReport"
+ "code": {
+ "description": "Machine readable code or warning type. The warning code value is `200`.",
+ "type": "string"
+ },
+ "data": {
+ "description": "Key-value pairs to give detailed information on the warning.",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "Key associated with a key-value pair to give detailed information on the warning.",
+ "type": "string"
},
- "type": "array"
+ "value": {
+ "description": "Value associated with a key-value pair to give detailed information on the warning.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "warnings": {
- "description": "Warnings, if any.",
- "items": {
- "properties": {
- "code": {
- "description": "Machine readable code or warning type. The warning code value is `200`.",
- "type": "string"
- },
- "data": {
- "description": "Key-value pairs to give detailed information on the warning.",
- "items": {
- "properties": {
- "key": {
- "description": "Key associated with a key-value pair to give detailed information on the warning.",
- "type": "string"
- },
- "value": {
- "description": "Value associated with a key-value pair to give detailed information on the warning.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "message": {
- "description": "The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"`application name`\" is not available. - Partial data is available warning - Data for date yyyy-mm-dd for application \"`application name`\" is not available right now, please try again after a few hours. ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
+ "type": "array"
+ },
+ "message": {
+ "description": "The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"`application name`\" is not available. - Partial data is available warning - Data for date yyyy-mm-dd for application \"`application name`\" is not available right now, please try again after a few hours. ",
+ "type": "string"
+ }
},
"type": "object"
+ },
+ "type": "array"
}
- },
- "servicePath": "",
- "title": "Admin SDK API",
- "version": "reports_v1"
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Admin SDK API",
+ "version": "reports_v1"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json
index 90e066e894d..e4fe75ccd91 100644
--- a/googleapiclient/discovery_cache/documents/admob.v1.json
+++ b/googleapiclient/discovery_cache/documents/admob.v1.json
@@ -321,7 +321,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdUnit": {
diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json
index f67b5d589db..99ddd7951a6 100644
--- a/googleapiclient/discovery_cache/documents/admob.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json
@@ -321,7 +321,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdUnit": {
diff --git a/googleapiclient/discovery_cache/documents/adsense.v1.4.json b/googleapiclient/discovery_cache/documents/adsense.v1.4.json
index 671ea81cb8c..05ae1884db7 100644
--- a/googleapiclient/discovery_cache/documents/adsense.v1.4.json
+++ b/googleapiclient/discovery_cache/documents/adsense.v1.4.json
@@ -1,1583 +1,1146 @@
{
- "kind": "discovery#restDescription",
- "canonicalName": "AdSense",
- "protocol": "rest",
- "id": "adsense:v1.4",
- "revision": "20201002",
- "resources": {
- "payments": {
- "methods": {
- "list": {
- "id": "adsense.payments.list",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "response": {
- "$ref": "Payments"
- },
- "description": "List the payments for this AdSense account.",
- "httpMethod": "GET",
- "path": "payments"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adsense": {
+ "description": "View and manage your AdSense data"
+ },
+ "https://www.googleapis.com/auth/adsense.readonly": {
+ "description": "View your AdSense data"
}
}
+ }
+ },
+ "basePath": "/adsense/v1.4/",
+ "baseUrl": "https://www.googleapis.com/adsense/v1.4/",
+ "batchPath": "batch/adsense/v1.4",
+ "canonicalName": "AdSense",
+ "description": "Accesses AdSense publishers' inventory and generates performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/adsense/management/",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/adsense-16.png",
+ "x32": "https://www.google.com/images/icons/product/adsense-32.png"
+ },
+ "id": "adsense:v1.4",
+ "kind": "discovery#restDescription",
+ "name": "adsense",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "savedadstyles": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "Deprecated. Please use quotaUser instead.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
"methods": {
- "list": {
- "description": "List all saved ad styles in the user's account.",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string"
- },
- "maxResults": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "maximum": "10000",
- "minimum": "0"
- }
- },
- "id": "adsense.savedadstyles.list",
- "path": "savedadstyles",
- "httpMethod": "GET",
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
"get": {
+ "description": "Get information about the selected AdSense account.",
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
+ "id": "adsense.accounts.get",
"parameterOrder": [
- "savedAdStyleId"
+ "accountId"
],
- "path": "savedadstyles/{savedAdStyleId}",
"parameters": {
- "savedAdStyleId": {
+ "accountId": {
+ "description": "Account to get information about.",
"location": "path",
- "description": "Saved ad style to retrieve.",
"required": true,
"type": "string"
- }
- },
- "id": "adsense.savedadstyles.get",
- "description": "Get a specific saved ad style from the user's account."
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
},
- "maxResults": {
- "minimum": "0",
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "tree": {
+ "description": "Whether the tree of sub accounts should be returned.",
"location": "query",
- "format": "int32",
- "maximum": "10000"
+ "type": "boolean"
}
},
- "path": "adclients",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "id": "adsense.adclients.list",
+ "path": "accounts/{accountId}",
"response": {
- "$ref": "AdClients"
- },
- "description": "List all ad clients in this AdSense account."
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "parameters": {
- "adClientId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Ad client which contains the custom channel."
- },
- "customChannelId": {
- "location": "path",
- "description": "Custom channel to retrieve.",
- "required": true,
- "type": "string"
- }
+ "$ref": "Account"
},
- "description": "Get the specified custom channel from the specified ad client.",
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "id": "adsense.customchannels.get"
+ ]
},
"list": {
+ "description": "List all accounts available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.list",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string"
- },
"maxResults": {
+ "description": "The maximum number of accounts to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
"maximum": "10000",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "type": "integer",
"minimum": "0",
- "location": "query",
- "format": "int32"
+ "type": "integer"
},
- "adClientId": {
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path",
+ "pageToken": {
+ "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
"type": "string"
}
},
- "id": "adsense.customchannels.list",
- "parameterOrder": [
- "adClientId"
- ],
+ "path": "accounts",
+ "response": {
+ "$ref": "Accounts"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this AdSense account.",
- "path": "adclients/{adClientId}/customchannels",
- "response": {
- "$ref": "CustomChannels"
- }
+ ]
}
},
"resources": {
- "adunits": {
+ "adclients": {
"methods": {
- "list": {
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "id": "adsense.customchannels.adunits.list",
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
+ "getAdCode": {
+ "description": "Get Auto ad code for a given ad client.",
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
+ "id": "adsense.accounts.adclients.getAdCode",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
],
- "description": "List all ad units in the specified custom channel.",
- "response": {
- "$ref": "AdUnits"
- },
"parameters": {
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "maximum": "10000",
- "format": "int32",
- "location": "query"
- },
- "includeInactive": {
- "description": "Whether to include inactive ad units. Default: true.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query",
- "type": "string"
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"adClientId": {
- "required": true,
- "type": "string",
+ "description": "Ad client to get the code for.",
"location": "path",
- "description": "Ad client which contains the custom channel."
- },
- "customChannelId": {
"required": true,
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "location": "path"
+ "type": "string"
+ },
+ "tagPartner": {
+ "description": "Tag partner to include in the ad code snippet.",
+ "location": "query",
+ "type": "string"
}
- }
- }
- }
- }
- }
- },
- "reports": {
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "httpMethod": "GET",
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adcode",
"response": {
- "$ref": "AdsenseReportsGenerateResponse"
+ "$ref": "AdCode"
},
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "path": "reports/{savedReportId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all ad clients in the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adclients.list",
+ "parameterOrder": [
+ "accountId"
+ ],
"parameters": {
- "savedReportId": {
+ "accountId": {
+ "description": "Account for which to list ad clients.",
"location": "path",
"required": true,
- "type": "string",
- "description": "The saved report to retrieve."
- },
- "locale": {
- "pattern": "[a-zA-Z_]+",
- "location": "query",
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified."
+ "type": "string"
},
"maxResults": {
- "type": "integer",
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
"format": "int32",
- "maximum": "50000",
"location": "query",
- "description": "The maximum number of rows of report data to return.",
- "minimum": "0"
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
},
- "startIndex": {
- "format": "int32",
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
"location": "query",
- "minimum": "0",
- "type": "integer",
- "maximum": "5000",
- "description": "Index of the first row of report data to return."
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "adunits": {
+ "methods": {
+ "get": {
+ "description": "Gets the specified ad unit in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.get",
"parameterOrder": [
- "savedReportId"
+ "accountId",
+ "adClientId",
+ "adUnitId"
],
- "id": "adsense.reports.saved.generate",
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to get the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
- "list": {
+ "getAdCode": {
+ "description": "Get ad code for the specified ad unit.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.getAdCode",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get the code for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
"response": {
- "$ref": "SavedReports"
+ "$ref": "AdCode"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all ad units in the specified ad client for the specified account.",
"httpMethod": "GET",
+ "id": "adsense.accounts.adunits.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
"parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
"maxResults": {
- "type": "integer",
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
"location": "query",
+ "maximum": "10000",
"minimum": "0",
- "format": "int32",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "maximum": "100"
+ "type": "integer"
},
"pageToken": {
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
+ "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
- "description": "List all saved reports in this AdSense account.",
- "path": "reports/saved",
- "id": "adsense.reports.saved.list",
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
- }
- }
- },
- "methods": {
- "generate": {
- "id": "adsense.reports.generate",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "supportsMediaDownload": true,
- "parameters": {
- "startIndex": {
- "minimum": "0",
- "format": "int32",
- "type": "integer",
- "maximum": "5000",
- "location": "query",
- "description": "Index of the first row of report data to return."
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- },
- "filter": {
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "type": "string",
- "location": "query",
- "repeated": true,
- "description": "Filters to be run on the report."
- },
- "accountId": {
- "type": "string",
- "location": "query",
- "repeated": true,
- "description": "Accounts upon which to report."
- },
- "currency": {
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "type": "string",
- "location": "query",
- "pattern": "[a-zA-Z]+"
- },
- "locale": {
- "type": "string",
- "location": "query",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+"
- },
- "dimension": {
- "type": "string",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query",
- "description": "Dimensions to base the report on."
- },
- "maxResults": {
- "minimum": "0",
- "maximum": "50000",
- "location": "query",
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32"
- },
- "startDate": {
- "type": "string",
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query",
- "required": true,
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive."
- },
- "metric": {
- "description": "Numeric columns to include in the report.",
- "location": "query",
- "type": "string",
- "pattern": "[a-zA-Z_]+",
- "repeated": true
- },
- "endDate": {
- "type": "string",
- "required": true,
- "location": "query",
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive."
- },
- "sort": {
- "location": "query",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending."
- }
},
- "httpMethod": "GET",
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "path": "reports"
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adsense.alerts.list",
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameters": {
- "locale": {
- "location": "query",
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported."
- }
- },
- "httpMethod": "GET",
- "description": "List the alerts for this AdSense account.",
- "path": "alerts"
- },
- "delete": {
- "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
- "id": "adsense.alerts.delete",
- "path": "alerts/{alertId}",
- "parameters": {
- "alertId": {
- "required": true,
- "description": "Alert to delete.",
- "location": "path",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ],
- "parameterOrder": [
- "alertId"
- ],
- "httpMethod": "DELETE"
- }
- }
- },
- "accounts": {
- "methods": {
- "list": {
- "path": "accounts",
- "parameters": {
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- },
- "maxResults": {
- "format": "int32",
- "maximum": "10000",
- "minimum": "0",
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "location": "query"
- }
- },
- "httpMethod": "GET",
- "id": "adsense.accounts.list",
- "description": "List all accounts available to this AdSense account.",
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Account"
- },
- "id": "adsense.accounts.get",
- "parameters": {
- "tree": {
- "type": "boolean",
- "location": "query",
- "description": "Whether the tree of sub accounts should be returned."
- },
- "accountId": {
- "description": "Account to get information about.",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "path": "accounts/{accountId}",
- "description": "Get information about the selected AdSense account.",
- "parameterOrder": [
- "accountId"
- ]
- }
- },
- "resources": {
- "customchannels": {
"resources": {
- "adunits": {
+ "customchannels": {
"methods": {
"list": {
+ "description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.customchannels.list",
"parameterOrder": [
"accountId",
"adClientId",
- "customChannelId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
+ "adUnitId"
],
- "description": "List all ad units in the specified custom channel.",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "id": "adsense.accounts.customchannels.adunits.list",
"parameters": {
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
"accountId": {
- "type": "string",
- "required": true,
+ "description": "Account to which the ad client belongs.",
"location": "path",
- "description": "Account to which the ad client belongs."
+ "required": true,
+ "type": "string"
},
- "customChannelId": {
- "description": "Custom channel for which to list ad units.",
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"maxResults": {
- "minimum": "0",
- "maximum": "10000",
- "description": "The maximum number of ad units to include in the response, used for paging.",
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
},
- "adClientId": {
- "location": "path",
- "required": true,
- "description": "Ad client which contains the custom channel.",
+ "pageToken": {
+ "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
"type": "string"
}
},
- "httpMethod": "GET",
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
"response": {
- "$ref": "AdUnits"
- }
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
}
}
- },
+ }
+ },
+ "alerts": {
"methods": {
- "list": {
- "id": "adsense.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
+ "delete": {
+ "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsense.accounts.alerts.delete",
+ "parameterOrder": [
+ "accountId",
+ "alertId"
+ ],
"parameters": {
"accountId": {
- "required": true,
+ "description": "Account which contains the ad unit.",
"location": "path",
- "type": "string",
- "description": "Account to which the ad client belongs."
- },
- "pageToken": {
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query",
+ "required": true,
"type": "string"
},
- "adClientId": {
- "description": "Ad client for which to list custom channels.",
- "required": true,
+ "alertId": {
+ "description": "Alert to delete.",
"location": "path",
+ "required": true,
"type": "string"
- },
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "maximum": "10000",
- "type": "integer",
- "format": "int32"
}
},
+ "path": "accounts/{accountId}/alerts/{alertId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense"
+ ]
+ },
+ "list": {
+ "description": "List the alerts for the specified AdSense account.",
"httpMethod": "GET",
+ "id": "adsense.accounts.alerts.list",
"parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "description": "List all custom channels in the specified ad client for the specified account.",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
+ "accountId"
],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to retrieve the alerts.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/alerts",
"response": {
- "$ref": "CustomChannels"
- }
- },
- "get": {
+ "$ref": "Alerts"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
+ ]
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client for the specified account.",
+ "httpMethod": "GET",
"id": "adsense.accounts.customchannels.get",
"parameterOrder": [
"accountId",
"adClientId",
"customChannelId"
],
- "httpMethod": "GET",
"parameters": {
- "customChannelId": {
- "required": true,
- "description": "Custom channel to retrieve.",
- "type": "string",
- "location": "path"
- },
"accountId": {
- "required": true,
- "type": "string",
+ "description": "Account to which the ad client belongs.",
"location": "path",
- "description": "Account to which the ad client belongs."
+ "required": true,
+ "type": "string"
},
"adClientId": {
- "type": "string",
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
"required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
"location": "path",
- "description": "Ad client which contains the custom channel."
+ "required": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
"response": {
"$ref": "CustomChannel"
},
- "description": "Get the specified custom channel from the specified ad client for the specified account.",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}"
- }
- }
- },
- "adunits": {
- "resources": {
- "customchannels": {
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all custom channels in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.customchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adunits": {
"methods": {
"list": {
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "description": "List all custom channels which the specified ad unit belongs to.",
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.customchannels.adunits.list",
"parameterOrder": [
"accountId",
"adClientId",
- "adUnitId"
+ "customChannelId"
],
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "id": "adsense.accounts.adunits.customchannels.list",
"parameters": {
- "adUnitId": {
- "description": "Ad unit for which to list custom channels.",
- "required": true,
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
"location": "path",
+ "required": true,
"type": "string"
},
"adClientId": {
- "description": "Ad client which contains the ad unit.",
+ "description": "Ad client which contains the custom channel.",
"location": "path",
"required": true,
"type": "string"
},
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "format": "int32",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "type": "integer",
- "maximum": "10000"
- },
- "accountId": {
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
"location": "path",
"required": true,
- "description": "Account to which the ad client belongs.",
"type": "string"
},
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
"pageToken": {
- "type": "string",
+ "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
"location": "query",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response."
+ "type": "string"
}
},
- "httpMethod": "GET"
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
}
}
- },
+ }
+ },
+ "payments": {
"methods": {
- "getAdCode": {
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "list": {
+ "description": "List the payments for the specified AdSense account.",
"httpMethod": "GET",
+ "id": "adsense.accounts.payments.list",
"parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
+ "accountId"
],
- "response": {
- "$ref": "AdCode"
- },
- "id": "adsense.accounts.adunits.getAdCode",
- "description": "Get ad code for the specified ad unit.",
"parameters": {
"accountId": {
- "description": "Account which contains the ad client.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "adClientId": {
- "description": "Ad client with contains the ad unit.",
- "required": true,
+ "description": "Account for which to retrieve the payments.",
"location": "path",
- "type": "string"
- },
- "adUnitId": {
- "type": "string",
"required": true,
- "location": "path",
- "description": "Ad unit to get the code for."
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/payments",
+ "response": {
+ "$ref": "Payments"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
- },
- "list": {
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.reports.generate",
"parameterOrder": [
"accountId",
- "adClientId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
+ "startDate",
+ "endDate"
],
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for the specified account.",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "id": "adsense.accounts.adunits.list",
- "response": {
- "$ref": "AdUnits"
- },
"parameters": {
- "adClientId": {
- "required": true,
- "description": "Ad client for which to list ad units.",
+ "accountId": {
+ "description": "Account upon which to report.",
"location": "path",
+ "required": true,
"type": "string"
},
- "accountId": {
+ "currency": {
+ "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
+ "location": "query",
+ "pattern": "[a-zA-Z]+",
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
"required": true,
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "location": "path"
+ "type": "string"
},
- "pageToken": {
- "type": "string",
+ "filter": {
+ "description": "Filters to be run on the report.",
"location": "query",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response."
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
},
- "includeInactive": {
- "description": "Whether to include inactive ad units. Default: true.",
- "type": "boolean",
- "location": "query"
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
},
"maxResults": {
- "type": "integer",
- "location": "query",
- "maximum": "10000",
- "description": "The maximum number of ad units to include in the response, used for paging.",
+ "description": "The maximum number of rows of report data to return.",
"format": "int32",
- "minimum": "0"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "AdUnit"
- },
- "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- "parameters": {
- "adClientId": {
- "description": "Ad client for which to get the ad unit.",
- "type": "string",
- "location": "path",
- "required": true
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
},
- "adUnitId": {
- "location": "path",
- "type": "string",
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
"required": true,
- "description": "Ad unit to retrieve."
+ "type": "string"
},
- "accountId": {
- "location": "path",
- "description": "Account to which the ad client belongs.",
- "type": "string",
- "required": true
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "useTimezoneReporting": {
+ "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
+ "location": "query",
+ "type": "boolean"
}
},
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "id": "adsense.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "path": "accounts/{accountId}/alerts",
- "description": "List the alerts for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Account for which to retrieve the alerts."
- },
- "locale": {
- "location": "query",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "type": "string"
- }
- },
- "httpMethod": "GET",
- "response": {
- "$ref": "Alerts"
- },
- "id": "adsense.accounts.alerts.list",
- "parameterOrder": [
- "accountId"
- ]
- },
- "delete": {
- "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "location": "path",
- "required": true,
- "description": "Account which contains the ad unit.",
- "type": "string"
- },
- "alertId": {
- "location": "path",
- "type": "string",
- "description": "Alert to delete.",
- "required": true
- }
- },
- "path": "accounts/{accountId}/alerts/{alertId}",
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ],
- "parameterOrder": [
- "accountId",
- "alertId"
- ],
- "httpMethod": "DELETE",
- "id": "adsense.accounts.alerts.delete"
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.accounts.savedadstyles.get",
+ "path": "accounts/{accountId}/reports",
"response": {
- "$ref": "SavedAdStyle"
- },
- "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- "description": "List a specific saved ad style for the specified account.",
- "parameters": {
- "savedAdStyleId": {
- "type": "string",
- "required": true,
- "description": "Saved ad style to retrieve.",
- "location": "path"
- },
- "accountId": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Account for which to get the saved ad style."
- }
+ "$ref": "AdsenseReportsGenerateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
],
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "savedAdStyleId"
- ]
- },
- "list": {
- "description": "List all saved ad styles in the specified account.",
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameters": {
- "maxResults": {
- "minimum": "0",
- "type": "integer",
- "location": "query",
- "maximum": "10000",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32"
- },
- "accountId": {
- "location": "path",
- "type": "string",
- "description": "Account for which to list saved ad styles.",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response."
- }
- },
- "id": "adsense.accounts.savedadstyles.list",
- "path": "accounts/{accountId}/savedadstyles",
- "response": {
- "$ref": "SavedAdStyles"
- }
+ "supportsMediaDownload": true
}
- }
- },
- "reports": {
+ },
"resources": {
"saved": {
"methods": {
"generate": {
+ "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.reports.saved.generate",
+ "parameterOrder": [
+ "accountId",
+ "savedReportId"
+ ],
"parameters": {
- "savedReportId": {
- "type": "string",
- "location": "path",
- "description": "The saved report to retrieve.",
- "required": true
- },
"accountId": {
"description": "Account to which the saved reports belong.",
"location": "path",
"required": true,
"type": "string"
},
- "startIndex": {
- "maximum": "5000",
- "format": "int32",
- "minimum": "0",
- "description": "Index of the first row of report data to return.",
- "location": "query",
- "type": "integer"
- },
"locale": {
- "pattern": "[a-zA-Z_]+",
- "type": "string",
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
"location": "query",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified."
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
},
"maxResults": {
- "type": "integer",
- "location": "query",
- "format": "int32",
"description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
"maximum": "50000",
- "minimum": "0"
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
}
},
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "httpMethod": "GET",
- "id": "adsense.accounts.reports.saved.generate",
+ "path": "accounts/{accountId}/reports/{savedReportId}",
"response": {
"$ref": "AdsenseReportsGenerateResponse"
},
- "path": "accounts/{accountId}/reports/{savedReportId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
},
"list": {
+ "description": "List all saved reports in the specified AdSense account.",
"httpMethod": "GET",
+ "id": "adsense.accounts.reports.saved.list",
+ "parameterOrder": [
+ "accountId"
+ ],
"parameters": {
"accountId": {
- "type": "string",
- "required": true,
+ "description": "Account to which the saved reports belong.",
"location": "path",
- "description": "Account to which the saved reports belong."
+ "required": true,
+ "type": "string"
},
"maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
"format": "int32",
- "minimum": "0",
- "maximum": "100",
- "type": "integer",
"location": "query",
- "description": "The maximum number of saved reports to include in the response, used for paging."
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
},
"pageToken": {
- "location": "query",
"description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
"type": "string"
}
},
- "parameterOrder": [
- "accountId"
- ],
- "description": "List all saved reports in the specified AdSense account.",
- "id": "adsense.accounts.reports.saved.list",
"path": "accounts/{accountId}/reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "response": {
- "$ref": "SavedReports"
- }
+ ]
}
}
}
- },
+ }
+ },
+ "savedadstyles": {
"methods": {
- "generate": {
- "path": "accounts/{accountId}/reports",
- "id": "adsense.accounts.reports.generate",
+ "get": {
+ "description": "List a specific saved ad style for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.savedadstyles.get",
+ "parameterOrder": [
+ "accountId",
+ "savedAdStyleId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to get the saved ad style.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "savedAdStyleId": {
+ "description": "Saved ad style to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
"response": {
- "$ref": "AdsenseReportsGenerateResponse"
+ "$ref": "SavedAdStyle"
},
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "supportsMediaDownload": true,
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved ad styles in the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.savedadstyles.list",
+ "parameterOrder": [
+ "accountId"
],
"parameters": {
- "dimension": {
- "type": "string",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "description": "Dimensions to base the report on.",
- "location": "query"
- },
"accountId": {
- "type": "string",
+ "description": "Account for which to list saved ad styles.",
"location": "path",
- "description": "Account upon which to report.",
- "required": true
- },
- "filter": {
- "repeated": true,
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "description": "Filters to be run on the report.",
- "type": "string",
- "location": "query"
- },
- "currency": {
- "pattern": "[a-zA-Z]+",
- "type": "string",
- "location": "query",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set."
- },
- "locale": {
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "location": "query",
- "pattern": "[a-zA-Z_]+",
+ "required": true,
"type": "string"
},
"maxResults": {
+ "description": "The maximum number of saved ad styles to include in the response, used for paging.",
"format": "int32",
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "location": "query",
- "maximum": "50000",
- "minimum": "0"
- },
- "useTimezoneReporting": {
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "type": "boolean",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "required": true,
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "location": "query",
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)"
- },
- "sort": {
- "location": "query",
- "repeated": true,
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "type": "string"
- },
- "metric": {
- "repeated": true,
- "location": "query",
- "type": "string",
- "pattern": "[a-zA-Z_]+",
- "description": "Numeric columns to include in the report."
- },
- "endDate": {
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "type": "string",
"location": "query",
- "required": true
- },
- "startIndex": {
- "maximum": "5000",
+ "maximum": "10000",
"minimum": "0",
- "location": "query",
- "format": "int32",
- "type": "integer",
- "description": "Index of the first row of report data to return."
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "payments": {
- "methods": {
- "list": {
- "description": "List the payments for the specified AdSense account.",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameters": {
- "accountId": {
- "required": true,
- "description": "Account for which to retrieve the payments.",
- "location": "path",
- "type": "string"
- }
- },
- "httpMethod": "GET",
- "response": {
- "$ref": "Payments"
- },
- "parameterOrder": [
- "accountId"
- ],
- "path": "accounts/{accountId}/payments",
- "id": "adsense.accounts.payments.list"
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "id": "adsense.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Account for which to list ad clients."
+ "type": "integer"
},
"pageToken": {
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
"location": "query",
"type": "string"
- },
- "maxResults": {
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "type": "integer",
- "maximum": "10000",
- "format": "int32",
- "minimum": "0",
- "location": "query"
}
},
- "description": "List all ad clients in the specified account."
- },
- "getAdCode": {
- "description": "Get Auto ad code for a given ad client.",
+ "path": "accounts/{accountId}/savedadstyles",
"response": {
- "$ref": "AdCode"
+ "$ref": "SavedAdStyles"
},
- "id": "adsense.accounts.adclients.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adcode",
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameters": {
- "tagPartner": {
- "location": "query",
- "description": "Tag partner to include in the ad code snippet.",
- "type": "string"
- },
- "accountId": {
- "description": "Account which contains the ad client.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Ad client to get the code for."
- }
- },
- "httpMethod": "GET"
+ ]
}
}
},
"urlchannels": {
"methods": {
"list": {
+ "description": "List all URL channels in the specified ad client for the specified account.",
"httpMethod": "GET",
+ "id": "adsense.accounts.urlchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
"parameters": {
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response."
- },
"accountId": {
- "location": "path",
- "type": "string",
"description": "Account to which the ad client belongs.",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"adClientId": {
- "type": "string",
+ "description": "Ad client for which to list URL channels.",
"location": "path",
"required": true,
- "description": "Ad client for which to list URL channels."
+ "type": "string"
},
"maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
"minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
"location": "query",
- "format": "int32",
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "maximum": "10000"
+ "type": "string"
}
},
- "description": "List all URL channels in the specified ad client for the specified account.",
+ "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
"response": {
"$ref": "UrlChannels"
},
- "id": "adsense.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "parameterOrder": [
- "accountId",
- "adClientId"
]
}
}
}
}
},
- "urlchannels": {
+ "adclients": {
"methods": {
"list": {
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "id": "adsense.urlchannels.list",
- "response": {
- "$ref": "UrlChannels"
- },
- "description": "List all URL channels in the specified ad client for this AdSense account.",
- "parameterOrder": [
- "adClientId"
- ],
- "path": "adclients/{adClientId}/urlchannels",
+ "description": "List all ad clients in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.adclients.list",
"parameters": {
"maxResults": {
- "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
"format": "int32",
+ "location": "query",
"maximum": "10000",
- "type": "integer",
"minimum": "0",
- "location": "query"
+ "type": "integer"
},
"pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- },
- "adClientId": {
- "location": "path",
- "description": "Ad client for which to list URL channels.",
- "type": "string",
- "required": true
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
- "httpMethod": "GET"
- }
- }
- },
- "metadata": {
- "resources": {
- "metrics": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "id": "adsense.metadata.metrics.list",
- "httpMethod": "GET",
- "path": "metadata/metrics",
- "description": "List the metadata for the metrics available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- }
- }
- }
- },
- "dimensions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "id": "adsense.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "description": "List the metadata for the dimensions available to this AdSense account.",
- "httpMethod": "GET"
- }
- }
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
}
},
"adunits": {
"methods": {
"get": {
- "response": {
- "$ref": "AdUnit"
- },
+ "description": "Gets the specified ad unit in the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.get",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
"parameters": {
"adClientId": {
+ "description": "Ad client for which to get the ad unit.",
"location": "path",
- "type": "string",
"required": true,
- "description": "Ad client for which to get the ad unit."
+ "type": "string"
},
"adUnitId": {
"description": "Ad unit to retrieve.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
}
},
- "httpMethod": "GET",
+ "path": "adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "description": "Gets the specified ad unit in the specified ad client.",
- "id": "adsense.adunits.get",
+ ]
+ },
+ "getAdCode": {
+ "description": "Get ad code for the specified ad unit.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.getAdCode",
"parameterOrder": [
"adClientId",
"adUnitId"
],
- "path": "adclients/{adClientId}/adunits/{adUnitId}"
- },
- "getAdCode": {
- "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "description": "Get ad code for the specified ad unit.",
"parameters": {
- "adUnitId": {
- "required": true,
- "description": "Ad unit to get the code for.",
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
"location": "path",
+ "required": true,
"type": "string"
},
- "adClientId": {
+ "adUnitId": {
+ "description": "Ad unit to get the code for.",
"location": "path",
"required": true,
- "type": "string",
- "description": "Ad client with contains the ad unit."
+ "type": "string"
}
},
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "httpMethod": "GET",
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "response": {
+ "$ref": "AdCode"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
- ],
- "id": "adsense.adunits.getAdCode",
- "response": {
- "$ref": "AdCode"
- }
+ ]
},
"list": {
+ "description": "List all ad units in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
"id": "adsense.adunits.list",
"parameterOrder": [
"adClientId"
],
- "description": "List all ad units in the specified ad client for this AdSense account.",
"parameters": {
- "pageToken": {
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query",
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
"type": "string"
},
"includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
"location": "query",
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true."
- },
- "adClientId": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Ad client for which to list ad units."
+ "type": "boolean"
},
"maxResults": {
- "format": "int32",
"description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
"location": "query",
"maximum": "10000",
- "type": "integer",
- "minimum": "0"
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
"path": "adclients/{adClientId}/adunits",
"response": {
"$ref": "AdUnits"
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
},
"resources": {
"customchannels": {
"methods": {
"list": {
- "id": "adsense.adunits.customchannels.list",
- "httpMethod": "GET",
"description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.customchannels.list",
"parameterOrder": [
"adClientId",
"adUnitId"
],
- "response": {
- "$ref": "CustomChannels"
- },
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
"parameters": {
- "adUnitId": {
- "type": "string",
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
"location": "path",
- "description": "Ad unit for which to list custom channels.",
- "required": true
- },
- "pageToken": {
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
+ "required": true,
+ "type": "string"
},
- "adClientId": {
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
"location": "path",
"required": true,
- "type": "string",
- "description": "Ad client which contains the ad unit."
+ "type": "string"
},
"maxResults": {
"description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
"location": "query",
"maximum": "10000",
"minimum": "0",
- "type": "integer",
- "format": "int32"
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
@@ -1586,170 +1149,875 @@
}
}
}
- }
- },
- "servicePath": "adsense/v1.4/",
- "discoveryVersion": "v1",
- "baseUrl": "https://www.googleapis.com/adsense/v1.4/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsense": {
- "description": "View and manage your AdSense data"
+ },
+ "alerts": {
+ "methods": {
+ "delete": {
+ "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsense.alerts.delete",
+ "parameterOrder": [
+ "alertId"
+ ],
+ "parameters": {
+ "alertId": {
+ "description": "Alert to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "alerts/{alertId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense"
+ ]
},
- "https://www.googleapis.com/auth/adsense.readonly": {
- "description": "View your AdSense data"
+ "list": {
+ "description": "List the alerts for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.alerts.list",
+ "parameters": {
+ "locale": {
+ "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "alerts",
+ "response": {
+ "$ref": "Alerts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
}
- }
- },
- "parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for the response.",
- "default": "json",
- "location": "query",
- "enum": [
- "csv",
- "json"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ]
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "userIp": {
- "description": "Deprecated. Please use quotaUser instead.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
},
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all custom channels in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adunits": {
+ "methods": {
+ "list": {
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.adunits.list",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "resources": {
+ "dimensions": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the dimensions available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.metadata.dimensions.list",
+ "path": "metadata/dimensions",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the metrics available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.metadata.metrics.list",
+ "path": "metadata/metrics",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "payments": {
+ "methods": {
+ "list": {
+ "description": "List the payments for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.payments.list",
+ "path": "payments",
+ "response": {
+ "$ref": "Payments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.generate",
+ "parameterOrder": [
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Accounts upon which to report.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "currency": {
+ "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
+ "location": "query",
+ "pattern": "[a-zA-Z]+",
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "useTimezoneReporting": {
+ "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "reports",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.saved.generate",
+ "parameterOrder": [
+ "savedReportId"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports/{savedReportId}",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.saved.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "savedadstyles": {
+ "methods": {
+ "get": {
+ "description": "Get a specific saved ad style from the user's account.",
+ "httpMethod": "GET",
+ "id": "adsense.savedadstyles.get",
+ "parameterOrder": [
+ "savedAdStyleId"
+ ],
+ "parameters": {
+ "savedAdStyleId": {
+ "description": "Saved ad style to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "savedadstyles/{savedAdStyleId}",
+ "response": {
+ "$ref": "SavedAdStyle"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved ad styles in the user's account.",
+ "httpMethod": "GET",
+ "id": "adsense.savedadstyles.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved ad styles to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "savedadstyles",
+ "response": {
+ "$ref": "SavedAdStyles"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20201002",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "id": "Account",
+ "properties": {
+ "creation_time": {
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#account",
+ "description": "Kind of resource this is, in this case adsense#account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ },
+ "premium": {
+ "description": "Whether this account is premium.",
+ "type": "boolean"
+ },
+ "subAccounts": {
+ "description": "Sub accounts of the this account.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "timezone": {
+ "description": "AdSense timezone of this account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Accounts": {
+ "id": "Accounts",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The accounts returned in this list response.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#accounts",
+ "description": "Kind of list this is, in this case adsense#accounts.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#adClient",
+ "description": "Kind of resource this is, in this case adsense#adClient.",
+ "type": "string"
+ },
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#adClients",
+ "description": "Kind of list this is, in this case adsense#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdCode": {
+ "id": "AdCode",
+ "properties": {
+ "adCode": {
+ "description": "The Auto ad code snippet. The ad code snippet.",
+ "type": "string"
+ },
+ "ampBody": {
+ "description": "The AMP Auto ad code snippet that goes in the body of an AMP page.",
+ "type": "string"
+ },
+ "ampHead": {
+ "description": "The AMP Auto ad code snippet that goes in the head of an AMP page.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#adCode",
+ "description": "Kind this is, in this case adsense#adCode.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdStyle": {
+ "id": "AdStyle",
+ "properties": {
+ "colors": {
+ "description": "The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
+ "properties": {
+ "background": {
+ "description": "The color of the ad background.",
+ "type": "string"
+ },
+ "border": {
+ "description": "The color of the ad border.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The color of the ad text.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The color of the ad title.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The color of the ad url.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "corners": {
+ "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
+ "type": "string"
+ },
+ "font": {
+ "description": "The font which is included in the style.",
+ "properties": {
+ "family": {
+ "description": "The family of the font.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the font.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "adsense#adStyle",
+ "description": "Kind this is, in this case adsense#adStyle.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "quotaUser": {
- "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
- "type": "string",
- "location": "query"
- }
- },
- "rootUrl": "https://www.googleapis.com/",
- "description": "Accesses AdSense publishers' inventory and generates performance reports.",
- "icons": {
- "x32": "https://www.google.com/images/icons/product/adsense-32.png",
- "x16": "https://www.google.com/images/icons/product/adsense-16.png"
- },
- "name": "adsense",
- "schemas": {
- "CustomChannel": {
- "type": "object",
+ "AdUnit": {
+ "id": "AdUnit",
"properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
"code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "contentAdsSettings": {
+ "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
+ "properties": {
+ "backupOption": {
+ "description": "The backup option to be used in instances where no ad is available.",
+ "properties": {
+ "color": {
+ "description": "Color to use when type is set to COLOR.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the backup option. Possible values are BLANK, COLOR and URL.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to use when type is set to URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "customStyle": {
+ "$ref": "AdStyle",
+ "description": "Custom style information specific to this ad unit."
+ },
+ "feedAdsSettings": {
+ "description": "Settings specific to feed ads (AFF) - deprecated.",
+ "properties": {
+ "adPosition": {
+ "description": "The position of the ads relative to the feed entries.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minimumWordCount": {
+ "description": "The minimum length an entry should be in order to have attached ads.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The type of ads which should appear.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
+ "type": "string"
},
"kind": {
- "description": "Kind of resource this is, in this case adsense#customChannel.",
- "default": "adsense#customChannel",
+ "default": "adsense#adUnit",
+ "description": "Kind of resource this is, in this case adsense#adUnit.",
"type": "string"
},
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
+ "mobileContentAdsSettings": {
+ "description": "Settings specific to WAP mobile content ads (AFMC) - deprecated.",
"properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
+ "markupLanguage": {
+ "description": "The markup language to use for this ad unit.",
+ "type": "string"
},
- "location": {
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "scriptingLanguage": {
+ "description": "The scripting language to use for this ad unit.",
"type": "string"
},
- "description": {
- "type": "string",
- "description": "The external description of the channel."
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
},
- "siteLanguage": {
- "description": "The language of the sites ads will be displayed on.",
+ "type": {
+ "description": "Type of this ad unit.",
"type": "string"
}
- }
+ },
+ "type": "object"
},
"name": {
- "type": "string",
- "description": "Name of this custom channel."
+ "description": "Name of this ad unit.",
+ "type": "string"
+ },
+ "savedStyleId": {
+ "description": "ID of the saved ad style which holds this ad unit's style information.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "type": "string"
}
},
- "id": "CustomChannel"
+ "type": "object"
},
- "AdsenseReportsGenerateResponse": {
+ "AdUnits": {
+ "id": "AdUnits",
"properties": {
- "rows": {
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "type": "array",
- "items": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "endDate": {
- "type": "string",
- "description": "The requested end date in yyyy-mm-dd format."
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
},
- "startDate": {
- "type": "string",
- "description": "The requested start date in yyyy-mm-dd format."
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
+ },
+ "type": "array"
},
"kind": {
- "default": "adsense#report",
- "type": "string",
- "description": "Kind this is, in this case adsense#report."
+ "default": "adsense#adUnits",
+ "description": "Kind of list this is, in this case adsense#adUnits.",
+ "type": "string"
},
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdsenseReportsGenerateResponse": {
+ "id": "AdsenseReportsGenerateResponse",
+ "properties": {
"averages": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty."
- },
- "totals": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty."
+ "type": "array"
},
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
+ "endDate": {
+ "description": "The requested end date in yyyy-mm-dd format.",
+ "type": "string"
},
"headers": {
+ "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
"items": {
"properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
"name": {
"description": "The name of the header.",
"type": "string"
@@ -1757,694 +2025,426 @@
"type": {
"description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
"type": "string"
- },
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
}
},
"type": "object"
},
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#report",
+ "description": "Kind this is, in this case adsense#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "startDate": {
+ "description": "The requested start date in yyyy-mm-dd format.",
+ "type": "string"
+ },
+ "totalMatchedRows": {
+ "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
"type": "array"
},
"warnings": {
"description": "Any warnings associated with generation of the report.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
}
},
- "id": "AdsenseReportsGenerateResponse",
"type": "object"
},
- "Payment": {
+ "Alert": {
+ "id": "Alert",
"properties": {
- "paymentAmountCurrencyCode": {
- "type": "string",
- "description": "The currency code for the amount to be paid."
- },
- "paymentAmount": {
- "type": "string",
- "description": "The amount to be paid."
- },
- "paymentDate": {
- "type": "string",
- "description": "The date this payment was/will be credited to the user, or none if the payment threshold has not been met."
- },
"id": {
- "description": "Unique identifier of this Payment.",
+ "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
"type": "string"
},
- "kind": {
- "description": "Kind of resource this is, in this case adsense#payment.",
- "type": "string",
- "default": "adsense#payment"
- }
- },
- "type": "object",
- "id": "Payment"
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "ampHead": {
- "type": "string",
- "description": "The AMP Auto ad code snippet that goes in the head of an AMP page."
+ "isDismissible": {
+ "description": "Whether this alert can be dismissed.",
+ "type": "boolean"
},
"kind": {
- "type": "string",
- "default": "adsense#adCode",
- "description": "Kind this is, in this case adsense#adCode."
- },
- "adCode": {
- "type": "string",
- "description": "The Auto ad code snippet. The ad code snippet."
- },
- "ampBody": {
- "type": "string",
- "description": "The AMP Auto ad code snippet that goes in the body of an AMP page."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "description": "ETag of this response for caching purposes.",
+ "default": "adsense#alert",
+ "description": "Kind of resource this is, in this case adsense#alert.",
"type": "string"
},
- "kind": {
- "description": "Kind of list this is, in this case adsense#accounts.",
- "type": "string",
- "default": "adsense#accounts"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "Account"
- },
- "description": "The accounts returned in this list response."
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedReport.",
- "default": "adsense#savedReport"
+ "message": {
+ "description": "The localized alert message.",
+ "type": "string"
},
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
+ "severity": {
+ "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE.",
+ "type": "string"
},
- "name": {
- "type": "string",
- "description": "This saved report's name."
+ "type": {
+ "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
- "Metadata": {
- "type": "object",
+ "Alerts": {
+ "id": "Alerts",
"properties": {
- "kind": {
- "type": "string",
- "default": "adsense#metadata",
- "description": "Kind of list this is, in this case adsense#metadata."
- },
"items": {
+ "description": "The alerts returned in this list response.",
"items": {
- "$ref": "ReportingMetadataEntry"
+ "$ref": "Alert"
},
"type": "array"
+ },
+ "kind": {
+ "default": "adsense#alerts",
+ "description": "Kind of list this is, in this case adsense#alerts.",
+ "type": "string"
}
},
- "id": "Metadata"
+ "type": "object"
},
- "Payments": {
- "type": "object",
+ "CustomChannel": {
+ "id": "CustomChannel",
"properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
+ "type": "string"
+ },
"kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#payments.",
- "default": "adsense#payments"
+ "default": "adsense#customChannel",
+ "description": "Kind of resource this is, in this case adsense#customChannel.",
+ "type": "string"
},
- "items": {
- "description": "The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.",
- "type": "array",
- "items": {
- "$ref": "Payment"
- }
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ },
+ "targetingInfo": {
+ "description": "The targeting information of this custom channel, if activated.",
+ "properties": {
+ "adsAppearOn": {
+ "description": "The name used to describe this channel externally.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The external description of the channel.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "type": "string"
+ },
+ "siteLanguage": {
+ "description": "The language of the sites ads will be displayed on.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
- "id": "Payments"
+ "type": "object"
},
- "AdClients": {
+ "CustomChannels": {
+ "id": "CustomChannels",
"properties": {
- "kind": {
- "description": "Kind of list this is, in this case adsense#adClients.",
- "default": "adsense#adClients",
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
"type": "string"
},
"items": {
- "description": "The ad clients returned in this list response.",
- "type": "array",
+ "description": "The custom channels returned in this list response.",
"items": {
- "$ref": "AdClient"
- }
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
},
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
+ "kind": {
+ "default": "adsense#customChannels",
+ "description": "Kind of list this is, in this case adsense#customChannels.",
+ "type": "string"
},
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
},
- "type": "object",
- "id": "AdClients"
+ "type": "object"
},
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
+ "Metadata": {
+ "id": "Metadata",
"properties": {
- "kind": {
- "type": "string",
- "default": "adsense#urlChannels",
- "description": "Kind of list this is, in this case adsense#urlChannels."
- },
"items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
"items": {
- "$ref": "UrlChannel"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
+ "$ref": "ReportingMetadataEntry"
+ },
+ "type": "array"
},
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
+ "kind": {
+ "default": "adsense#metadata",
+ "description": "Kind of list this is, in this case adsense#metadata.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
- "Alerts": {
- "id": "Alerts",
- "type": "object",
+ "Payment": {
+ "id": "Payment",
"properties": {
+ "id": {
+ "description": "Unique identifier of this Payment.",
+ "type": "string"
+ },
"kind": {
- "description": "Kind of list this is, in this case adsense#alerts.",
- "type": "string",
- "default": "adsense#alerts"
+ "default": "adsense#payment",
+ "description": "Kind of resource this is, in this case adsense#payment.",
+ "type": "string"
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "Alert"
- },
- "description": "The alerts returned in this list response."
+ "paymentAmount": {
+ "description": "The amount to be paid.",
+ "type": "string"
+ },
+ "paymentAmountCurrencyCode": {
+ "description": "The currency code for the amount to be paid.",
+ "type": "string"
+ },
+ "paymentDate": {
+ "description": "The date this payment was/will be credited to the user, or none if the payment threshold has not been met.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
- "SavedAdStyles": {
+ "Payments": {
+ "id": "Payments",
"properties": {
"items": {
+ "description": "The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.",
"items": {
- "$ref": "SavedAdStyle"
+ "$ref": "Payment"
},
- "description": "The saved ad styles returned in this list response.",
"type": "array"
},
- "nextPageToken": {
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
- "type": "string"
- },
- "etag": {
- "description": "ETag of this response for caching purposes.",
- "type": "string"
- },
"kind": {
- "description": "Kind of list this is, in this case adsense#savedAdStyles.",
- "default": "adsense#savedAdStyles",
+ "default": "adsense#payments",
+ "description": "Kind of list this is, in this case adsense#payments.",
"type": "string"
}
},
- "id": "SavedAdStyles",
"type": "object"
},
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
+ "ReportingMetadataEntry": {
+ "id": "ReportingMetadataEntry",
"properties": {
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "mobileContentAdsSettings": {
- "properties": {
- "type": {
- "description": "Type of this ad unit.",
- "type": "string"
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "description": "Size of this ad unit.",
- "type": "string"
- },
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- }
+ "compatibleDimensions": {
+ "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
+ "items": {
+ "type": "string"
},
- "description": "Settings specific to WAP mobile content ads (AFMC) - deprecated.",
- "type": "object"
- },
- "savedStyleId": {
- "type": "string",
- "description": "ID of the saved ad style which holds this ad unit's style information."
+ "type": "array"
},
- "contentAdsSettings": {
- "properties": {
- "backupOption": {
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "url": {
- "description": "URL to use when type is set to URL.",
- "type": "string"
- },
- "color": {
- "description": "Color to use when type is set to COLOR.",
- "type": "string"
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- }
- },
- "type": "object"
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- },
- "size": {
- "description": "Size of this ad unit.",
- "type": "string"
- }
+ "compatibleMetrics": {
+ "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
+ "items": {
+ "type": "string"
},
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
- "type": "object"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "kind": {
- "default": "adsense#adUnit",
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adUnit."
- },
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- },
- "feedAdsSettings": {
- "description": "Settings specific to feed ads (AFF) - deprecated.",
- "type": "object",
- "properties": {
- "minimumWordCount": {
- "description": "The minimum length an entry should be in order to have attached ads.",
- "type": "integer",
- "format": "int32"
- },
- "frequency": {
- "format": "int32",
- "type": "integer",
- "description": "The frequency at which ads should appear in the feed (i.e. every N entries)."
- },
- "adPosition": {
- "description": "The position of the ads relative to the feed entries.",
- "type": "string"
- },
- "type": {
- "description": "The type of ads which should appear.",
- "type": "string"
- }
- }
+ "type": "array"
},
"id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- }
- }
- },
- "UrlChannel": {
- "type": "object",
- "properties": {
+ "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.",
+ "type": "string"
+ },
"kind": {
- "default": "adsense#urlChannel",
- "description": "Kind of resource this is, in this case adsense#urlChannel.",
+ "default": "adsense#reportingMetadataEntry",
+ "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
"type": "string"
},
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
+ "requiredDimensions": {
+ "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "requiredMetrics": {
+ "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "urlPattern": {
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
- "type": "string"
+ "supportedProducts": {
+ "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "UrlChannel"
+ "type": "object"
},
- "Alert": {
- "type": "object",
+ "SavedAdStyle": {
+ "id": "SavedAdStyle",
"properties": {
- "severity": {
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE.",
- "type": "string"
- },
- "message": {
- "description": "The localized alert message.",
- "type": "string"
- },
- "isDismissible": {
- "description": "Whether this alert can be dismissed.",
- "type": "boolean"
+ "adStyle": {
+ "$ref": "AdStyle",
+ "description": "The AdStyle itself."
},
- "type": {
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.",
+ "id": {
+ "description": "Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
"type": "string"
},
"kind": {
- "default": "adsense#alert",
- "description": "Kind of resource this is, in this case adsense#alert.",
+ "default": "adsense#savedAdStyle",
+ "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
"type": "string"
},
- "id": {
- "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
+ "name": {
+ "description": "The user selected name of this SavedAdStyle.",
"type": "string"
}
},
- "id": "Alert"
+ "type": "object"
},
- "AdUnits": {
+ "SavedAdStyles": {
+ "id": "SavedAdStyles",
"properties": {
- "kind": {
- "type": "string",
- "default": "adsense#adUnits",
- "description": "Kind of list this is, in this case adsense#adUnits."
- },
"etag": {
"description": "ETag of this response for caching purposes.",
"type": "string"
},
"items": {
- "description": "The ad units returned in this list response.",
+ "description": "The saved ad styles returned in this list response.",
"items": {
- "$ref": "AdUnit"
+ "$ref": "SavedAdStyle"
},
"type": "array"
},
+ "kind": {
+ "default": "adsense#savedAdStyles",
+ "description": "Kind of list this is, in this case adsense#savedAdStyles.",
+ "type": "string"
+ },
"nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
},
- "type": "object",
- "id": "AdUnits"
+ "type": "object"
},
- "CustomChannels": {
- "type": "object",
+ "SavedReport": {
+ "id": "SavedReport",
"properties": {
- "nextPageToken": {
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "id": {
+ "description": "Unique identifier of this saved report.",
"type": "string"
},
"kind": {
- "description": "Kind of list this is, in this case adsense#customChannels.",
- "default": "adsense#customChannels",
+ "default": "adsense#savedReport",
+ "description": "Kind of resource this is, in this case adsense#savedReport.",
"type": "string"
},
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "description": "The custom channels returned in this list response.",
- "type": "array",
- "items": {
- "$ref": "CustomChannel"
- }
+ "name": {
+ "description": "This saved report's name.",
+ "type": "string"
}
},
- "id": "CustomChannels"
+ "type": "object"
},
"SavedReports": {
"id": "SavedReports",
"properties": {
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedReports.",
- "default": "adsense#savedReports"
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
"etag": {
"description": "ETag of this response for caching purposes.",
"type": "string"
},
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- },
- "type": "object"
- },
- "Account": {
- "properties": {
- "id": {
- "description": "Unique identifier of this account.",
- "type": "string"
- },
- "premium": {
- "description": "Whether this account is premium.",
- "type": "boolean"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#account.",
- "default": "adsense#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "subAccounts": {
+ "items": {
+ "description": "The saved reports returned in this list response.",
"items": {
- "$ref": "Account"
+ "$ref": "SavedReport"
},
- "description": "Sub accounts of the this account.",
"type": "array"
},
- "creation_time": {
- "type": "string",
- "format": "int64"
- },
- "timezone": {
- "type": "string",
- "description": "AdSense timezone of this account."
- }
- },
- "id": "Account",
- "type": "object"
- },
- "AdStyle": {
- "id": "AdStyle",
- "properties": {
"kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adStyle.",
- "default": "adsense#adStyle"
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "description": "The family of the font.",
- "type": "string"
- },
- "size": {
- "description": "The size of the font.",
- "type": "string"
- }
- }
- },
- "colors": {
- "properties": {
- "url": {
- "description": "The color of the ad url.",
- "type": "string"
- },
- "background": {
- "description": "The color of the ad background.",
- "type": "string"
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- }
- },
- "type": "object",
- "description": "The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash."
+ "default": "adsense#savedReports",
+ "description": "Kind of list this is, in this case adsense#savedReports.",
+ "type": "string"
},
- "corners": {
- "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
+ "nextPageToken": {
+ "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
"type": "string"
}
},
"type": "object"
},
- "SavedAdStyle": {
- "type": "object",
- "id": "SavedAdStyle",
+ "UrlChannel": {
+ "id": "UrlChannel",
"properties": {
"id": {
- "type": "string",
- "description": "Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "name": {
- "description": "The user selected name of this SavedAdStyle.",
+ "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
"type": "string"
},
- "adStyle": {
- "$ref": "AdStyle",
- "description": "The AdStyle itself."
- },
"kind": {
- "default": "adsense#savedAdStyle",
- "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
- "type": "string"
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "description": "Whether this ad client is opted in to ARC.",
- "type": "boolean"
- },
- "id": {
- "description": "Unique identifier of this ad client.",
+ "default": "adsense#urlChannel",
+ "description": "Kind of resource this is, in this case adsense#urlChannel.",
"type": "string"
},
- "kind": {
- "description": "Kind of resource this is, in this case adsense#adClient.",
- "type": "string",
- "default": "adsense#adClient"
- },
- "supportsReporting": {
- "description": "Whether this ad client supports being reported on.",
- "type": "boolean"
- },
- "productCode": {
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
"type": "string"
}
- }
+ },
+ "type": "object"
},
- "ReportingMetadataEntry": {
+ "UrlChannels": {
+ "id": "UrlChannels",
"properties": {
- "kind": {
- "default": "adsense#reportingMetadataEntry",
- "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
"type": "string"
},
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "compatibleDimensions": {
- "items": {
- "type": "string"
- },
- "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
- "type": "array"
- },
- "compatibleMetrics": {
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "requiredDimensions": {
+ "items": {
+ "description": "The URL channels returned in this list response.",
"items": {
- "type": "string"
+ "$ref": "UrlChannel"
},
- "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
"type": "array"
},
- "supportedProducts": {
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "kind": {
+ "default": "adsense#urlChannels",
+ "description": "Kind of list this is, in this case adsense#urlChannels.",
+ "type": "string"
},
- "requiredMetrics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted."
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
},
- "type": "object",
- "id": "ReportingMetadataEntry"
+ "type": "object"
}
},
- "basePath": "/adsense/v1.4/",
- "version": "v1.4",
- "ownerName": "Google",
- "documentationLink": "https://developers.google.com/adsense/management/",
- "batchPath": "batch/adsense/v1.4",
- "ownerDomain": "google.com",
- "title": "AdSense Management API"
-}
+ "servicePath": "adsense/v1.4/",
+ "title": "AdSense Management API",
+ "version": "v1.4"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/adsensehost.v4.1.json b/googleapiclient/discovery_cache/documents/adsensehost.v4.1.json
index a3c3cd33e0e..4e59e80b1e8 100644
--- a/googleapiclient/discovery_cache/documents/adsensehost.v4.1.json
+++ b/googleapiclient/discovery_cache/documents/adsensehost.v4.1.json
@@ -1,5 +1,4 @@
{
- "canonicalName": "AdSense Host",
"auth": {
"oauth2": {
"scopes": {
@@ -9,454 +8,189 @@
}
}
},
- "rootUrl": "https://www.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adsensehost",
+ "basePath": "/adsensehost/v4.1/",
+ "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
"batchPath": "batch/adsensehost/v4.1",
- "title": "AdSense Host API",
- "ownerName": "Google",
+ "canonicalName": "AdSense Host",
+ "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/adsense/host/",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/adsense-16.png",
+ "x32": "https://www.google.com/images/icons/product/adsense-32.png"
+ },
+ "id": "adsensehost:v4.1",
+ "kind": "discovery#restDescription",
"labels": [
"limited_availability"
],
+ "name": "adsensehost",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "Deprecated. Please use quotaUser instead.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
- "adclients": {
+ "accounts": {
"methods": {
"get": {
- "id": "adsensehost.adclients.get",
- "path": "adclients/{adClientId}",
- "description": "Get information about one of the ad clients in the Host AdSense account.",
+ "description": "Get information about the selected associated AdSense account.",
"httpMethod": "GET",
- "response": {
- "$ref": "AdClient"
- },
+ "id": "adsensehost.accounts.get",
"parameterOrder": [
- "adClientId"
+ "accountId"
],
"parameters": {
- "adClientId": {
+ "accountId": {
+ "description": "Account to get information about.",
"location": "path",
- "description": "Ad client to get.",
- "type": "string",
- "required": true
+ "required": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
},
"list": {
- "response": {
- "$ref": "AdClients"
- },
+ "description": "List hosted accounts associated with this AdSense account by ad client id.",
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "maximum": "10000",
- "type": "integer",
- "minimum": "0",
- "location": "query"
- },
- "pageToken": {
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
- }
- },
- "path": "adclients",
- "id": "adsensehost.adclients.list",
- "description": "List all host ad clients in this AdSense account."
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "response": {
- "$ref": "Report"
- },
+ "id": "adsensehost.accounts.list",
"parameterOrder": [
- "startDate",
- "endDate"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
+ "filterAdClientId"
],
"parameters": {
- "locale": {
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "type": "string",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "endDate": {
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "type": "string",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "metric": {
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
+ "filterAdClientId": {
+ "description": "Ad clients to list accounts for.",
"location": "query",
- "description": "Numeric columns to include in the report.",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "maximum": "50000",
- "type": "integer",
- "minimum": "0",
- "location": "query"
- },
- "sort": {
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "type": "string",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
"repeated": true,
- "location": "query"
- },
- "startDate": {
- "location": "query",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "type": "string",
"required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)"
- },
- "dimension": {
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query",
- "description": "Dimensions to base the report on.",
"type": "string"
- },
- "filter": {
- "description": "Filters to be run on the report.",
- "type": "string",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "startIndex": {
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "maximum": "5000",
- "type": "integer",
- "minimum": "0",
- "location": "query"
}
},
- "path": "reports",
- "id": "adsensehost.reports.generate",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter."
- }
- }
- },
- "urlchannels": {
- "methods": {
- "delete": {
- "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
- "id": "adsensehost.urlchannels.delete",
- "description": "Delete a URL channel from the host AdSense account.",
+ "path": "accounts",
"response": {
- "$ref": "UrlChannel"
- },
- "parameterOrder": [
- "adClientId",
- "urlChannelId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "adClientId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Ad client from which to delete the URL channel."
- },
- "urlChannelId": {
- "description": "URL channel to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- }
+ "$ref": "Accounts"
},
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
- },
- "insert": {
- "path": "adclients/{adClientId}/urlchannels",
- "id": "adsensehost.urlchannels.insert",
- "description": "Add a new URL channel to the host AdSense account.",
- "request": {
- "$ref": "UrlChannel"
- },
- "response": {
- "$ref": "UrlChannel"
- },
- "parameterOrder": [
- "adClientId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "adClientId": {
- "location": "path",
- "description": "Ad client to which the new URL channel will be added.",
- "type": "string",
- "required": true
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "UrlChannels"
- },
- "parameterOrder": [
- "adClientId"
- ],
- "parameters": {
- "pageToken": {
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "format": "uint32",
- "maximum": "10000",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of URL channels to include in the response, used for paging."
- },
- "adClientId": {
- "description": "Ad client for which to list URL channels.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "id": "adsensehost.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "description": "List all host URL channels in the host AdSense account."
- }
- }
- },
- "associationsessions": {
- "methods": {
- "start": {
- "description": "Create an association session for initiating an association with an AdSense user.",
- "response": {
- "$ref": "AssociationSession"
- },
- "parameterOrder": [
- "productCode",
- "websiteUrl"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "userLocale": {
- "type": "string",
- "location": "query",
- "description": "The preferred locale of the user."
- },
- "websiteUrl": {
- "type": "string",
- "required": true,
- "location": "query",
- "description": "The URL of the user's hosted website."
- },
- "callbackUrl": {
- "description": "The URL to redirect the user to once association is completed. It receives a token parameter that can then be used to retrieve the associated account.",
- "type": "string",
- "location": "query"
- },
- "websiteLocale": {
- "location": "query",
- "description": "The locale of the user's hosted website.",
- "type": "string"
- },
- "productCode": {
- "type": "string",
- "required": true,
- "repeated": true,
- "enumDescriptions": [
- "AdSense For Content",
- "AdSense For Games",
- "AdSense For Mobile Content - deprecated",
- "AdSense For Search - deprecated",
- "AdSense For Video"
- ],
- "location": "query",
- "description": "Products to associate with the user.",
- "enum": [
- "AFC",
- "AFG",
- "AFMC",
- "AFS",
- "AFV"
- ]
- }
- },
- "path": "associationsessions/start",
- "id": "adsensehost.associationsessions.start"
- },
- "verify": {
- "path": "associationsessions/verify",
- "id": "adsensehost.associationsessions.verify",
- "description": "Verify an association session after the association callback returns from AdSense signup.",
- "response": {
- "$ref": "AssociationSession"
- },
- "parameterOrder": [
- "token"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "token": {
- "location": "query",
- "description": "The token returned to the association callback URL.",
- "type": "string",
- "required": true
- }
- }
- }
- }
- },
- "accounts": {
- "methods": {
- "get": {
- "description": "Get information about the selected associated AdSense account.",
- "response": {
- "$ref": "Account"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "accountId": {
- "description": "Account to get information about.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "path": "accounts/{accountId}",
- "id": "adsensehost.accounts.get"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Accounts"
- },
- "parameterOrder": [
- "filterAdClientId"
- ],
- "parameters": {
- "filterAdClientId": {
- "type": "string",
- "required": true,
- "repeated": true,
- "location": "query",
- "description": "Ad clients to list accounts for."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "id": "adsensehost.accounts.list",
- "path": "accounts",
- "description": "List hosted accounts associated with this AdSense account by ad client id."
}
},
"resources": {
"adclients": {
"methods": {
"get": {
- "response": {
- "$ref": "AdClient"
- },
+ "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adclients.get",
"parameterOrder": [
"accountId",
"adClientId"
],
- "httpMethod": "GET",
"parameters": {
"accountId": {
- "location": "path",
"description": "Account which contains the ad client.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"adClientId": {
- "location": "path",
"description": "Ad client to get.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}",
+ "response": {
+ "$ref": "AdClient"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "path": "accounts/{accountId}/adclients/{adClientId}",
- "id": "adsensehost.accounts.adclients.get",
- "description": "Get information about one of the ad clients in the specified publisher's AdSense account."
+ ]
},
"list": {
- "id": "adsensehost.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
"description": "List all hosted ad clients in the specified hosted account.",
"httpMethod": "GET",
- "response": {
- "$ref": "AdClients"
- },
+ "id": "adsensehost.accounts.adclients.list",
"parameterOrder": [
"accountId"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string"
- },
"accountId": {
- "location": "path",
"description": "Account for which to list ad clients.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
"format": "uint32",
+ "location": "query",
"maximum": "10000",
- "type": "integer",
"minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
"location": "query",
- "description": "The maximum number of ad clients to include in the response, used for paging."
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
@@ -465,87 +199,47 @@
},
"adunits": {
"methods": {
- "insert": {
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "id": "adsensehost.accounts.adunits.insert",
- "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
- "parameters": {
- "adClientId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Ad client into which to insert the ad unit."
- },
- "accountId": {
- "location": "path",
- "description": "Account which will contain the ad unit.",
- "type": "string",
- "required": true
- }
- }
- },
- "patch": {
- "response": {
- "$ref": "AdUnit"
- },
+ "delete": {
+ "description": "Delete the specified ad unit from the specified publisher AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsensehost.accounts.adunits.delete",
"parameterOrder": [
"accountId",
"adClientId",
"adUnitId"
],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
"parameters": {
"accountId": {
- "description": "Account which contains the ad client.",
- "type": "string",
+ "description": "Account which contains the ad unit.",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
},
"adClientId": {
- "description": "Ad client which contains the ad unit.",
- "type": "string",
+ "description": "Ad client for which to get ad unit.",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
},
"adUnitId": {
- "location": "query",
- "description": "Ad unit to get.",
- "type": "string",
- "required": true
+ "description": "Ad unit to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "id": "adsensehost.accounts.adunits.patch",
- "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
- "request": {
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
"$ref": "AdUnit"
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
},
"get": {
- "id": "adsensehost.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
"description": "Get the specified host ad unit in this AdSense account.",
"httpMethod": "GET",
- "response": {
- "$ref": "AdUnit"
- },
+ "id": "adsensehost.accounts.adunits.get",
"parameterOrder": [
"accountId",
"adClientId",
@@ -553,188 +247,228 @@
],
"parameters": {
"accountId": {
- "location": "path",
"description": "Account which contains the ad unit.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"adClientId": {
- "type": "string",
- "required": true,
+ "description": "Ad client for which to get ad unit.",
"location": "path",
- "description": "Ad client for which to get ad unit."
+ "required": true,
+ "type": "string"
},
"adUnitId": {
- "location": "path",
"description": "Ad unit to get.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
},
"getAdCode": {
"description": "Get ad code for the specified ad unit, attaching the specified host custom channels.",
- "response": {
- "$ref": "AdCode"
- },
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adunits.getAdCode",
"parameterOrder": [
"accountId",
"adClientId",
"adUnitId"
],
- "httpMethod": "GET",
"parameters": {
- "adClientId": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
"location": "path",
- "description": "Ad client with contains the ad unit.",
- "type": "string",
- "required": true
- },
- "adUnitId": {
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
"location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
"description": "Ad unit to get the code for.",
- "type": "string",
- "required": true
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"hostCustomChannelId": {
- "location": "query",
"description": "Host custom channel to attach to the ad code.",
- "type": "string",
- "repeated": true
- },
- "accountId": {
- "description": "Account which contains the ad client.",
- "type": "string",
- "required": true,
- "location": "path"
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "response": {
+ "$ref": "AdCode"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "id": "adsensehost.accounts.adunits.getAdCode"
+ ]
},
- "update": {
+ "insert": {
+ "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.accounts.adunits.insert",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which will contain the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client into which to insert the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
"request": {
"$ref": "AdUnit"
},
- "description": "Update the supplied ad unit in the specified publisher AdSense account.",
"response": {
"$ref": "AdUnit"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all ad units in the specified publisher's AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adunits.list",
"parameterOrder": [
"accountId",
"adClientId"
],
- "httpMethod": "PUT",
"parameters": {
"accountId": {
"description": "Account which contains the ad client.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
},
"adClientId": {
+ "description": "Ad client for which to list ad units.",
"location": "path",
- "description": "Ad client which contains the ad unit.",
- "type": "string",
- "required": true
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
"path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "id": "adsensehost.accounts.adunits.update"
- },
- "delete": {
- "httpMethod": "DELETE",
"response": {
- "$ref": "AdUnit"
+ "$ref": "AdUnits"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "patch": {
+ "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adsensehost.accounts.adunits.patch",
"parameterOrder": [
"accountId",
"adClientId",
"adUnitId"
],
"parameters": {
- "adClientId": {
- "type": "string",
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
"required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
"location": "path",
- "description": "Ad client for which to get ad unit."
+ "required": true,
+ "type": "string"
},
"adUnitId": {
- "description": "Ad unit to delete.",
- "type": "string",
+ "description": "Ad unit to get.",
+ "location": "query",
"required": true,
- "location": "path"
- },
- "accountId": {
- "location": "path",
- "description": "Account which contains the ad unit.",
- "type": "string",
- "required": true
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "request": {
+ "$ref": "AdUnit"
+ },
+ "response": {
+ "$ref": "AdUnit"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "id": "adsensehost.accounts.adunits.delete",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "description": "Delete the specified ad unit from the specified publisher AdSense account."
+ ]
},
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "AdUnits"
- },
+ "update": {
+ "description": "Update the supplied ad unit in the specified publisher AdSense account.",
+ "httpMethod": "PUT",
+ "id": "adsensehost.accounts.adunits.update",
"parameterOrder": [
"accountId",
"adClientId"
],
"parameters": {
- "includeInactive": {
- "location": "query",
- "description": "Whether to include inactive ad units. Default: true.",
- "type": "boolean"
- },
- "pageToken": {
- "location": "query",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string"
- },
"accountId": {
"description": "Account which contains the ad client.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "path"
- },
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "maximum": "10000",
- "type": "integer"
+ "type": "string"
},
"adClientId": {
- "type": "string",
- "required": true,
+ "description": "Ad client which contains the ad unit.",
"location": "path",
- "description": "Ad client for which to list ad units."
+ "required": true,
+ "type": "string"
}
},
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "request": {
+ "$ref": "AdUnit"
+ },
+ "response": {
+ "$ref": "AdUnit"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "id": "adsensehost.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "description": "List all ad units in the specified publisher's AdSense account."
+ ]
}
}
},
@@ -742,600 +476,789 @@
"methods": {
"generate": {
"description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "response": {
- "$ref": "Report"
- },
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.reports.generate",
"parameterOrder": [
"accountId",
"startDate",
"endDate"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
"parameters": {
- "maxResults": {
- "maximum": "50000",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of rows of report data to return."
- },
- "sort": {
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "type": "string",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive."
- },
"accountId": {
"description": "Hosted account upon which to report.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
},
"dimension": {
"description": "Dimensions to base the report on.",
- "type": "string",
+ "location": "query",
"pattern": "[a-zA-Z_]+",
"repeated": true,
- "location": "query"
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
},
"filter": {
"description": "Filters to be run on the report.",
- "type": "string",
+ "location": "query",
"pattern": "[a-zA-Z_]+(==|=@).+",
"repeated": true,
- "location": "query"
- },
- "startIndex": {
- "format": "uint32",
- "maximum": "5000",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "Index of the first row of report data to return."
+ "type": "string"
},
"locale": {
"description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "type": "string",
+ "location": "query",
"pattern": "[a-zA-Z_]+",
- "location": "query"
+ "type": "string"
},
- "endDate": {
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
"location": "query",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "type": "string",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)"
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
},
"metric": {
- "location": "query",
"description": "Numeric columns to include in the report.",
- "type": "string",
+ "location": "query",
"pattern": "[a-zA-Z_]+",
- "repeated": true
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
}
},
"path": "accounts/{accountId}/reports",
- "id": "adsensehost.accounts.reports.generate"
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
}
}
}
}
},
- "customchannels": {
+ "adclients": {
"methods": {
- "insert": {
- "response": {
- "$ref": "CustomChannel"
- },
+ "get": {
+ "description": "Get information about one of the ad clients in the Host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.adclients.get",
"parameterOrder": [
"adClientId"
],
- "httpMethod": "POST",
"parameters": {
"adClientId": {
+ "description": "Ad client to get.",
"location": "path",
- "description": "Ad client to which the new custom channel will be added.",
- "type": "string",
- "required": true
+ "required": true,
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}",
+ "response": {
+ "$ref": "AdClient"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all host ad clients in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.adclients.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "associationsessions": {
+ "methods": {
+ "start": {
+ "description": "Create an association session for initiating an association with an AdSense user.",
+ "httpMethod": "GET",
+ "id": "adsensehost.associationsessions.start",
+ "parameterOrder": [
+ "productCode",
+ "websiteUrl"
],
- "path": "adclients/{adClientId}/customchannels",
- "id": "adsensehost.customchannels.insert",
- "request": {
- "$ref": "CustomChannel"
+ "parameters": {
+ "callbackUrl": {
+ "description": "The URL to redirect the user to once association is completed. It receives a token parameter that can then be used to retrieve the associated account.",
+ "location": "query",
+ "type": "string"
+ },
+ "productCode": {
+ "description": "Products to associate with the user.",
+ "enum": [
+ "AFC",
+ "AFG",
+ "AFMC",
+ "AFS",
+ "AFV"
+ ],
+ "enumDescriptions": [
+ "AdSense For Content",
+ "AdSense For Games",
+ "AdSense For Mobile Content - deprecated",
+ "AdSense For Search - deprecated",
+ "AdSense For Video"
+ ],
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ },
+ "userLocale": {
+ "description": "The preferred locale of the user.",
+ "location": "query",
+ "type": "string"
+ },
+ "websiteLocale": {
+ "description": "The locale of the user's hosted website.",
+ "location": "query",
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "The URL of the user's hosted website.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "associationsessions/start",
+ "response": {
+ "$ref": "AssociationSession"
},
- "description": "Add a new custom channel to the host AdSense account."
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
},
- "patch": {
- "id": "adsensehost.customchannels.patch",
- "path": "adclients/{adClientId}/customchannels",
- "request": {
- "$ref": "CustomChannel"
+ "verify": {
+ "description": "Verify an association session after the association callback returns from AdSense signup.",
+ "httpMethod": "GET",
+ "id": "adsensehost.associationsessions.verify",
+ "parameterOrder": [
+ "token"
+ ],
+ "parameters": {
+ "token": {
+ "description": "The token returned to the association callback URL.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
},
- "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
- "httpMethod": "PATCH",
+ "path": "associationsessions/verify",
+ "response": {
+ "$ref": "AssociationSession"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "delete": {
+ "description": "Delete a specific custom channel from the host AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsensehost.customchannels.delete",
"parameterOrder": [
"adClientId",
"customChannelId"
],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client from which to delete the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
"response": {
"$ref": "CustomChannel"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "get": {
+ "description": "Get a specific custom channel from the host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
"parameters": {
+ "adClientId": {
+ "description": "Ad client from which to get the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"customChannelId": {
"description": "Custom channel to get.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "query"
- },
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "insert": {
+ "description": "Add a new custom channel to the host AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.customchannels.insert",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
"adClientId": {
- "description": "Ad client in which the custom channel will be updated.",
- "type": "string",
+ "description": "Ad client to which the new custom channel will be added.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "request": {
+ "$ref": "CustomChannel"
+ },
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all host custom channels in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
},
- "get": {
- "id": "adsensehost.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "description": "Get a specific custom channel from the host AdSense account.",
- "httpMethod": "GET",
- "response": {
- "$ref": "CustomChannel"
- },
+ "patch": {
+ "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adsensehost.customchannels.patch",
"parameterOrder": [
"adClientId",
"customChannelId"
],
"parameters": {
"adClientId": {
+ "description": "Ad client in which the custom channel will be updated.",
"location": "path",
- "description": "Ad client from which to get the custom channel.",
- "type": "string",
- "required": true
+ "required": true,
+ "type": "string"
},
"customChannelId": {
"description": "Custom channel to get.",
- "type": "string",
+ "location": "query",
"required": true,
- "location": "path"
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}/customchannels",
+ "request": {
+ "$ref": "CustomChannel"
+ },
+ "response": {
+ "$ref": "CustomChannel"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
]
},
"update": {
- "response": {
- "$ref": "CustomChannel"
- },
+ "description": "Update a custom channel in the host AdSense account.",
+ "httpMethod": "PUT",
+ "id": "adsensehost.customchannels.update",
"parameterOrder": [
"adClientId"
],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ],
"parameters": {
"adClientId": {
"description": "Ad client in which the custom channel will be updated.",
- "type": "string",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
}
},
"path": "adclients/{adClientId}/customchannels",
- "id": "adsensehost.customchannels.update",
- "description": "Update a custom channel in the host AdSense account.",
"request": {
"$ref": "CustomChannel"
- }
- },
- "delete": {
- "description": "Delete a specific custom channel from the host AdSense account.",
+ },
"response": {
"$ref": "CustomChannel"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
+ "httpMethod": "GET",
+ "id": "adsensehost.reports.generate",
"parameterOrder": [
- "adClientId",
- "customChannelId"
+ "startDate",
+ "endDate"
],
+ "parameters": {
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "delete": {
+ "description": "Delete a URL channel from the host AdSense account.",
"httpMethod": "DELETE",
+ "id": "adsensehost.urlchannels.delete",
+ "parameterOrder": [
+ "adClientId",
+ "urlChannelId"
+ ],
"parameters": {
"adClientId": {
- "description": "Ad client from which to delete the custom channel.",
- "type": "string",
+ "description": "Ad client from which to delete the URL channel.",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
},
- "customChannelId": {
+ "urlChannelId": {
+ "description": "URL channel to delete.",
"location": "path",
- "description": "Custom channel to delete.",
- "type": "string",
- "required": true
+ "required": true,
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
+ "response": {
+ "$ref": "UrlChannel"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "id": "adsensehost.customchannels.delete"
+ ]
},
- "list": {
- "description": "List all host custom channels in this AdSense account.",
- "response": {
- "$ref": "CustomChannels"
- },
+ "insert": {
+ "description": "Add a new URL channel to the host AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.urlchannels.insert",
"parameterOrder": [
"adClientId"
],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "maximum": "10000"
- },
"adClientId": {
- "description": "Ad client for which to list custom channels.",
- "type": "string",
+ "description": "Ad client to which the new URL channel will be added.",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
}
},
+ "path": "adclients/{adClientId}/urlchannels",
+ "request": {
+ "$ref": "UrlChannel"
+ },
+ "response": {
+ "$ref": "UrlChannel"
+ },
"scopes": [
"https://www.googleapis.com/auth/adsensehost"
- ],
- "path": "adclients/{adClientId}/customchannels",
- "id": "adsensehost.customchannels.list"
- }
- }
- }
- },
- "parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "quotaUser": {
- "location": "query",
- "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "type": "string"
- },
- "userIp": {
- "description": "Deprecated. Please use quotaUser instead.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ ]
+ },
+ "list": {
+ "description": "List all host URL channels in the host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
}
},
- "version": "v4.1",
- "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
- "kind": "discovery#restDescription",
- "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
- "servicePath": "adsensehost/v4.1/",
- "basePath": "/adsensehost/v4.1/",
- "id": "adsensehost:v4.1",
- "documentationLink": "https://developers.google.com/adsense/host/",
- "revision": "20200311",
- "discoveryVersion": "v1",
+ "revision": "20200930",
+ "rootUrl": "https://www.googleapis.com/",
"schemas": {
+ "Account": {
+ "id": "Account",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#account",
+ "description": "Kind of resource this is, in this case adsensehost#account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Approval status of this account. One of: PENDING, APPROVED, DISABLED.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Accounts": {
- "type": "object",
+ "id": "Accounts",
"properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
"items": {
"description": "The accounts returned in this list response.",
- "type": "array",
"items": {
"$ref": "Account"
- }
- },
- "etag": {
- "description": "ETag of this response for caching purposes.",
- "type": "string"
+ },
+ "type": "array"
},
"kind": {
+ "default": "adsensehost#accounts",
"description": "Kind of list this is, in this case adsensehost#accounts.",
- "type": "string",
- "default": "adsensehost#accounts"
+ "type": "string"
}
},
- "id": "Accounts"
+ "type": "object"
},
"AdClient": {
"id": "AdClient",
- "type": "object",
"properties": {
- "kind": {
- "description": "Kind of resource this is, in this case adsensehost#adClient.",
- "type": "string",
- "default": "adsensehost#adClient"
- },
"arcOptIn": {
"description": "Whether this ad client is opted in to ARC.",
"type": "boolean"
},
- "productCode": {
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
- "type": "string"
- },
"id": {
"description": "Unique identifier of this ad client.",
"type": "string"
},
- "supportsReporting": {
- "description": "Whether this ad client supports being reported on.",
- "type": "boolean"
- }
- }
- },
- "Report": {
- "type": "object",
- "properties": {
- "headers": {
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the header.",
- "type": "string"
- },
- "type": {
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
- "type": "string"
- },
- "currency": {
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
- "type": "string"
- }
- }
- }
- },
- "rows": {
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
"kind": {
- "description": "Kind this is, in this case adsensehost#report.",
- "type": "string",
- "default": "adsensehost#report"
- },
- "averages": {
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "totalMatchedRows": {
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64",
+ "default": "adsensehost#adClient",
+ "description": "Kind of resource this is, in this case adsensehost#adClient.",
"type": "string"
},
- "warnings": {
- "description": "Any warnings associated with generation of the report.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
},
- "totals": {
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
}
},
- "id": "Report"
+ "type": "object"
},
- "CustomChannels": {
- "type": "object",
+ "AdClients": {
+ "id": "AdClients",
"properties": {
"etag": {
"description": "ETag of this response for caching purposes.",
"type": "string"
},
- "nextPageToken": {
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
- "type": "string"
- },
- "kind": {
- "description": "Kind of list this is, in this case adsensehost#customChannels.",
- "type": "string",
- "default": "adsensehost#customChannels"
- },
"items": {
- "description": "The custom channels returned in this list response.",
- "type": "array",
+ "description": "The ad clients returned in this list response.",
"items": {
- "$ref": "CustomChannel"
- }
- }
- },
- "id": "CustomChannels"
- },
- "CustomChannel": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of this custom channel.",
- "type": "string"
+ "$ref": "AdClient"
+ },
+ "type": "array"
},
"kind": {
- "description": "Kind of resource this is, in this case adsensehost#customChannel.",
- "type": "string",
- "default": "adsensehost#customChannel"
- },
- "code": {
- "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "default": "adsensehost#adClients",
+ "description": "Kind of list this is, in this case adsensehost#adClients.",
"type": "string"
},
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
},
- "id": "CustomChannel"
+ "type": "object"
},
- "AdUnits": {
- "type": "object",
+ "AdCode": {
+ "id": "AdCode",
"properties": {
- "nextPageToken": {
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "adCode": {
+ "description": "The ad code snippet.",
"type": "string"
},
"kind": {
- "description": "Kind of list this is, in this case adsensehost#adUnits.",
- "type": "string",
- "default": "adsensehost#adUnits"
- },
- "items": {
- "description": "The ad units returned in this list response.",
- "type": "array",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "etag": {
- "description": "ETag of this response for caching purposes.",
+ "default": "adsensehost#adCode",
+ "description": "Kind this is, in this case adsensehost#adCode.",
"type": "string"
}
},
- "id": "AdUnits"
+ "type": "object"
},
- "UrlChannels": {
- "type": "object",
+ "AdStyle": {
+ "id": "AdStyle",
"properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "UrlChannel"
+ "colors": {
+ "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
+ "properties": {
+ "background": {
+ "description": "The color of the ad background.",
+ "type": "string"
+ },
+ "border": {
+ "description": "The color of the ad border.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The color of the ad text.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The color of the ad title.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The color of the ad url.",
+ "type": "string"
+ }
},
- "description": "The URL channels returned in this list response."
+ "type": "object"
},
- "etag": {
- "description": "ETag of this response for caching purposes.",
+ "corners": {
+ "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
"type": "string"
},
- "nextPageToken": {
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
- "type": "string"
+ "font": {
+ "description": "The font which is included in the style.",
+ "properties": {
+ "family": {
+ "description": "The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"kind": {
- "description": "Kind of list this is, in this case adsensehost#urlChannels.",
- "type": "string",
- "default": "adsensehost#urlChannels"
- }
- },
- "id": "UrlChannels"
- },
- "Account": {
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of this account.",
- "type": "string"
- },
- "status": {
- "description": "Approval status of this account. One of: PENDING, APPROVED, DISABLED.",
- "type": "string"
- },
- "name": {
- "description": "Name of this account.",
+ "default": "adsensehost#adStyle",
+ "description": "Kind this is, in this case adsensehost#adStyle.",
"type": "string"
- },
- "kind": {
- "type": "string",
- "default": "adsensehost#account",
- "description": "Kind of resource this is, in this case adsensehost#account."
}
},
- "id": "Account"
+ "type": "object"
},
"AdUnit": {
- "type": "object",
+ "id": "AdUnit",
"properties": {
+ "code": {
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
"contentAdsSettings": {
"description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
- "type": "object",
"properties": {
- "size": {
- "description": "Size of this ad unit. Size values are in the form SIZE_{width}_{height}.",
- "type": "string"
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK."
- },
"backupOption": {
"description": "The backup option to be used in instances where no ad is available.",
- "type": "object",
"properties": {
"color": {
"description": "Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
@@ -1349,122 +1272,95 @@
"description": "URL to use when type is set to URL.",
"type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "size": {
+ "description": "Size of this ad unit. Size values are in the form SIZE_{width}_{height}.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
- "status": {
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "customStyle": {
+ "$ref": "AdStyle",
+ "description": "Custom style information specific to this ad unit."
+ },
+ "id": {
+ "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
"type": "string"
},
- "name": {
- "description": "Name of this ad unit.",
+ "kind": {
+ "default": "adsensehost#adUnit",
+ "description": "Kind of resource this is, in this case adsensehost#adUnit.",
"type": "string"
},
"mobileContentAdsSettings": {
"description": "Settings specific to WAP mobile content ads (AFMC - deprecated).",
- "type": "object",
"properties": {
"markupLanguage": {
"description": "The markup language to use for this ad unit.",
"type": "string"
},
- "size": {
- "description": "Size of this ad unit.",
- "type": "string"
- },
"scriptingLanguage": {
"description": "The scripting language to use for this ad unit.",
"type": "string"
},
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
+ },
"type": {
"description": "Type of this ad unit.",
"type": "string"
}
- }
+ },
+ "type": "object"
},
- "id": {
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
+ "name": {
+ "description": "Name of this ad unit.",
"type": "string"
},
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "kind": {
- "description": "Kind of resource this is, in this case adsensehost#adUnit.",
- "type": "string",
- "default": "adsensehost#adUnit"
- },
- "code": {
- "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
"type": "string"
}
},
- "id": "AdUnit"
+ "type": "object"
},
- "AdStyle": {
- "type": "object",
+ "AdUnits": {
+ "id": "AdUnits",
"properties": {
- "kind": {
- "description": "Kind this is, in this case adsensehost#adStyle.",
- "type": "string",
- "default": "adsensehost#adStyle"
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
},
- "font": {
- "type": "object",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA."
- },
- "size": {
- "description": "The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.",
- "type": "string"
- }
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
},
- "description": "The font which is included in the style."
+ "type": "array"
},
- "colors": {
- "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "type": "object",
- "properties": {
- "border": {
- "description": "The color of the ad border.",
- "type": "string"
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "background": {
- "description": "The color of the ad background.",
- "type": "string"
- },
- "url": {
- "description": "The color of the ad url.",
- "type": "string"
- },
- "title": {
- "description": "The color of the ad title.",
- "type": "string"
- }
- }
+ "kind": {
+ "default": "adsensehost#adUnits",
+ "description": "Kind of list this is, in this case adsensehost#adUnits.",
+ "type": "string"
},
- "corners": {
- "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
"type": "string"
}
},
- "id": "AdStyle"
+ "type": "object"
},
"AssociationSession": {
- "type": "object",
+ "id": "AssociationSession",
"properties": {
- "websiteLocale": {
- "description": "The locale of the user's hosted website.",
- "type": "string"
- },
"accountId": {
"description": "Hosted account id of the associated publisher after association. Present if status is ACCEPTED.",
"type": "string"
@@ -1473,101 +1369,205 @@
"description": "Unique identifier of this association session.",
"type": "string"
},
- "redirectUrl": {
- "description": "Redirect URL of this association session. Used to redirect users into the AdSense association flow.",
- "type": "string"
- },
"kind": {
+ "default": "adsensehost#associationSession",
"description": "Kind of resource this is, in this case adsensehost#associationSession.",
- "type": "string",
- "default": "adsensehost#associationSession"
+ "type": "string"
},
"productCodes": {
"description": "The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
+ },
+ "redirectUrl": {
+ "description": "Redirect URL of this association session. Used to redirect users into the AdSense association flow.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.",
+ "type": "string"
},
"userLocale": {
"description": "The preferred locale of the user themselves when going through the AdSense association flow.",
"type": "string"
},
+ "websiteLocale": {
+ "description": "The locale of the user's hosted website.",
+ "type": "string"
+ },
"websiteUrl": {
"description": "The URL of the user's hosted website.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
},
- "status": {
- "description": "Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.",
+ "id": {
+ "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#customChannel",
+ "description": "Kind of resource this is, in this case adsensehost#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
"type": "string"
}
},
- "id": "AssociationSession"
+ "type": "object"
},
- "AdCode": {
- "type": "object",
+ "CustomChannels": {
+ "id": "CustomChannels",
"properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
"kind": {
- "description": "Kind this is, in this case adsensehost#adCode.",
- "type": "string",
- "default": "adsensehost#adCode"
+ "default": "adsensehost#customChannels",
+ "description": "Kind of list this is, in this case adsensehost#customChannels.",
+ "type": "string"
},
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#report",
+ "description": "Kind this is, in this case adsensehost#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "totalMatchedRows": {
+ "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "AdCode"
+ "type": "object"
},
"UrlChannel": {
- "type": "object",
+ "id": "UrlChannel",
"properties": {
"id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "urlPattern": {
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
"type": "string"
},
"kind": {
+ "default": "adsensehost#urlChannel",
"description": "Kind of resource this is, in this case adsensehost#urlChannel.",
- "type": "string",
- "default": "adsensehost#urlChannel"
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
}
},
- "id": "UrlChannel"
+ "type": "object"
},
- "AdClients": {
- "id": "AdClients",
- "type": "object",
+ "UrlChannels": {
+ "id": "UrlChannels",
"properties": {
- "kind": {
- "description": "Kind of list this is, in this case adsensehost#adClients.",
- "type": "string",
- "default": "adsensehost#adClients"
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
},
"items": {
- "description": "The ad clients returned in this list response.",
- "type": "array",
+ "description": "The URL channels returned in this list response.",
"items": {
- "$ref": "AdClient"
- }
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
},
- "etag": {
- "description": "ETag of this response for caching purposes.",
+ "kind": {
+ "default": "adsensehost#urlChannels",
+ "description": "Kind of list this is, in this case adsensehost#urlChannels.",
"type": "string"
},
"nextPageToken": {
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
"type": "string"
}
- }
+ },
+ "type": "object"
}
},
- "icons": {
- "x32": "https://www.google.com/images/icons/product/adsense-32.png",
- "x16": "https://www.google.com/images/icons/product/adsense-16.png"
- },
- "protocol": "rest"
-}
+ "servicePath": "adsensehost/v4.1/",
+ "title": "AdSense Host API",
+ "version": "v4.1"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json
index 3d167a9ac40..5a8d65e22bd 100644
--- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json
@@ -284,7 +284,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://analyticsdata.googleapis.com/",
"schemas": {
"BatchRunPivotReportsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
index fca753ee321..a5dc53e3580 100644
--- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
+++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
@@ -825,7 +825,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
"ClaimDeviceRequest": {
diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
index ead3db65f70..687df1e783d 100644
--- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
+++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
@@ -2676,7 +2676,7 @@
}
}
},
- "revision": "20210519",
+ "revision": "20210527",
"rootUrl": "https://androidpublisher.googleapis.com/",
"schemas": {
"Apk": {
@@ -3725,7 +3725,7 @@
"type": "integer"
},
"priceAmountMicros": {
- "description": "Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is \u20ac1.99, price_amount_micros is 1990000.",
+ "description": "Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is \u20ac1.99, price_amount_micros is 1990000.",
"format": "int64",
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json
index ce12c224178..28ea2987acd 100644
--- a/googleapiclient/discovery_cache/documents/apigateway.v1.json
+++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json
@@ -1083,7 +1083,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210519",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
index 7066885b766..2661526199e 100644
--- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
@@ -1083,7 +1083,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210519",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json
index d3a111aeb08..bc0f8714548 100644
--- a/googleapiclient/discovery_cache/documents/apikeys.v2.json
+++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json
@@ -424,7 +424,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://apikeys.googleapis.com/",
"schemas": {
"Operation": {
diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json
index 6ab18200078..82b9b12fc9d 100644
--- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json
@@ -586,7 +586,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://area120tables.googleapis.com/",
"schemas": {
"BatchCreateRowsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
index 3f02d33e9d6..56d567febe4 100644
--- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
+++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
@@ -551,7 +551,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210525",
"rootUrl": "https://binaryauthorization.googleapis.com/",
"schemas": {
"AdmissionRule": {
diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
index 82712d975a3..d351e96ede4 100644
--- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
@@ -551,7 +551,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210525",
"rootUrl": "https://binaryauthorization.googleapis.com/",
"schemas": {
"AdmissionRule": {
diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json
index ab690c48255..8ff449b1898 100644
--- a/googleapiclient/discovery_cache/documents/calendar.v3.json
+++ b/googleapiclient/discovery_cache/documents/calendar.v3.json
@@ -1723,7 +1723,7 @@
}
}
},
- "revision": "20210520",
+ "revision": "20210526",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Acl": {
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index 5d7a1e54bcb..ca9a61c3f1e 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -601,7 +601,7 @@
}
}
},
- "revision": "20210514",
+ "revision": "20210522",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"ActionParameter": {
@@ -842,10 +842,10 @@
"properties": {
"action": {
"$ref": "FormAction",
- "description": "The form action data associated with an interactive card that was clicked. Only populated for CARD_CLICKED events. See the [Interactive Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information."
+ "description": "The form action data associated with an interactive card that was clicked. Only populated for CARD_CLICKED events. See the [Interactive Cards guide](/chat/how-tos/cards-onclick) for more information."
},
"configCompleteRedirectUrl": {
- "description": "The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. See the [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) for more information.",
+ "description": "The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. See the [Authorizing access to 3p services guide](/chat/how-tos/auth-3p) for more information.",
"type": "string"
},
"eventTime": {
diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json
index 399469c370a..2e14d59a266 100644
--- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json
+++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json
@@ -116,7 +116,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210527",
"rootUrl": "https://chromeuxreport.googleapis.com/",
"schemas": {
"Bin": {
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index 6dfc8f4bd08..537f00a9dd3 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -694,7 +694,7 @@
]
},
"updatePrimaryVersion": {
- "description": "Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key.",
+ "description": "Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
"httpMethod": "POST",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
@@ -1259,7 +1259,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210522",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
"AsymmetricDecryptRequest": {
diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json
index c17998737bf..d1c9e6ba5b8 100644
--- a/googleapiclient/discovery_cache/documents/container.v1.json
+++ b/googleapiclient/discovery_cache/documents/container.v1.json
@@ -2459,7 +2459,7 @@
}
}
},
- "revision": "20210505",
+ "revision": "20210517",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -5137,7 +5137,8 @@
"GKE_SERVICE_ACCOUNT_DELETED",
"GCE_QUOTA_EXCEEDED",
"SET_BY_OPERATOR",
- "CLOUD_KMS_KEY_ERROR"
+ "CLOUD_KMS_KEY_ERROR",
+ "CA_EXPIRING"
],
"enumDescriptions": [
"UNKNOWN indicates a generic condition.",
@@ -5145,7 +5146,8 @@
"GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot service account.",
"Google Compute Engine quota was exceeded.",
"Cluster state was manually changed by an SRE due to a system logic error.",
- "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption. More codes TBA"
+ "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.",
+ "Cluster CA is expiring soon."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
index 78bc513bc5f..fc878fe22ca 100644
--- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
@@ -1217,7 +1217,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210521",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"Artifact": {
diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
index 6a722f6c313..46993507ef4 100644
--- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
@@ -853,7 +853,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210521",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json
index 3e0e489b5a6..243ae736ccd 100644
--- a/googleapiclient/discovery_cache/documents/content.v2.1.json
+++ b/googleapiclient/discovery_cache/documents/content.v2.1.json
@@ -1,14370 +1,14695 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/content": {
- "description": "Manage your product listings and accounts for Google Shopping"
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/content": {
+ "description": "Manage your product listings and accounts for Google Shopping"
}
+ }
+ }
+ },
+ "basePath": "/content/v2.1/",
+ "baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/",
+ "batchPath": "batch",
+ "canonicalName": "Shopping Content",
+ "description": "Manage your product listings and accounts for Google Shopping",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/shopping-content/v2/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "content:v2.1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
+ "name": "content",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "basePath": "/content/v2.1/",
- "baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/",
- "batchPath": "batch",
- "canonicalName": "Shopping Content",
- "description": "Manage your product listings and accounts for Google Shopping",
- "discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/shopping-content/v2/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "content:v2.1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
- "name": "content",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
- }
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
- "protocol": "rest",
- "resources": {
- "accounts": {
- "methods": {
- "authinfo": {
- "description": "Returns information about the authenticated user.",
- "flatPath": "accounts/authinfo",
- "httpMethod": "GET",
- "id": "content.accounts.authinfo",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounts/authinfo",
- "response": {
- "$ref": "AccountsAuthInfoResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "claimwebsite": {
- "description": "Claims the website of a Merchant Center sub-account.",
- "flatPath": "{merchantId}/accounts/{accountId}/claimwebsite",
- "httpMethod": "POST",
- "id": "content.accounts.claimwebsite",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account whose website is claimed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "overwrite": {
- "description": "Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/claimwebsite",
- "response": {
- "$ref": "AccountsClaimWebsiteResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "custombatch": {
- "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
- "flatPath": "accounts/batch",
- "httpMethod": "POST",
- "id": "content.accounts.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounts/batch",
- "request": {
- "$ref": "AccountsCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a Merchant Center sub-account.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.delete",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "force": {
- "default": "false",
- "description": "Flag to delete sub-accounts with products. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a Merchant Center account.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "GET",
- "id": "content.accounts.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
- "enum": [
- "MERCHANT",
- "CSS"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Creates a Merchant Center sub-account.",
- "flatPath": "{merchantId}/accounts",
- "httpMethod": "POST",
- "id": "content.accounts.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "link": {
- "description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
- "flatPath": "{merchantId}/accounts/{accountId}/link",
- "httpMethod": "POST",
- "id": "content.accounts.link",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that should be linked.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/link",
- "request": {
- "$ref": "AccountsLinkRequest"
- },
- "response": {
- "$ref": "AccountsLinkResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accounts",
- "httpMethod": "GET",
- "id": "content.accounts.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "label": {
- "description": "If view is set to \"css\", only return accounts that are assigned label with given ID.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of accounts to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "view": {
- "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
- "enum": [
- "MERCHANT",
- "CSS"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts",
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "listlinks": {
- "description": "Returns the list of accounts linked to your Merchant Center account.",
- "flatPath": "{merchantId}/accounts/{accountId}/listlinks",
- "httpMethod": "GET",
- "id": "content.accounts.listlinks",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to list links.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of links to return in the response, used for pagination.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/listlinks",
- "response": {
- "$ref": "AccountsListLinksResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "PUT",
- "id": "content.accounts.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatelabels": {
- "description": "Updates labels that are assigned to the Merchant Center account by CSS user.",
- "flatPath": "{merchantId}/accounts/{accountId}/updatelabels",
- "httpMethod": "POST",
- "id": "content.accounts.updatelabels",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account whose labels are updated.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/updatelabels",
- "request": {
- "$ref": "AccountsUpdateLabelsRequest"
- },
- "response": {
- "$ref": "AccountsUpdateLabelsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- },
- "resources": {
- "credentials": {
- "methods": {
- "create": {
- "description": "Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.",
- "flatPath": "accounts/{accountId}/credentials",
- "httpMethod": "POST",
- "id": "content.accounts.credentials.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The merchant id of the account these credentials belong to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/credentials",
- "request": {
- "$ref": "AccountCredentials"
- },
- "response": {
- "$ref": "AccountCredentials"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "labels": {
- "methods": {
- "create": {
- "description": "Creates a new label, not assigned to any account.",
- "flatPath": "accounts/{accountId}/labels",
- "httpMethod": "POST",
- "id": "content.accounts.labels.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account this label belongs to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels",
- "request": {
- "$ref": "AccountLabel"
- },
- "response": {
- "$ref": "AccountLabel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a label and removes it from all accounts to which it was assigned.",
- "flatPath": "accounts/{accountId}/labels/{labelId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.labels.delete",
- "parameterOrder": [
- "accountId",
- "labelId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account that owns the label.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "labelId": {
- "description": "Required. The id of the label to delete.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels/{labelId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the labels assigned to an account.",
- "flatPath": "accounts/{accountId}/labels",
- "httpMethod": "GET",
- "id": "content.accounts.labels.list",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The account id for whose labels are to be listed.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels",
- "response": {
- "$ref": "ListAccountLabelsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a label.",
- "flatPath": "accounts/{accountId}/labels/{labelId}",
- "httpMethod": "PATCH",
- "id": "content.accounts.labels.patch",
- "parameterOrder": [
- "accountId",
- "labelId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account this label belongs to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "labelId": {
- "description": "Required. The id of the label to update.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels/{labelId}",
- "request": {
- "$ref": "AccountLabel"
- },
- "response": {
- "$ref": "AccountLabel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "returncarrier": {
- "methods": {
- "create": {
- "description": "Links return carrier to a merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier",
- "httpMethod": "POST",
- "id": "content.accounts.returncarrier.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier",
- "request": {
- "$ref": "AccountReturnCarrier"
- },
- "response": {
- "$ref": "AccountReturnCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Delete a return carrier in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.returncarrier.delete",
- "parameterOrder": [
- "accountId",
- "carrierAccountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "carrierAccountId": {
- "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists available return carriers in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier",
- "httpMethod": "GET",
- "id": "content.accounts.returncarrier.list",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier",
- "response": {
- "$ref": "ListAccountReturnCarrierResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a return carrier in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "httpMethod": "PATCH",
- "id": "content.accounts.returncarrier.patch",
- "parameterOrder": [
- "accountId",
- "carrierAccountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "carrierAccountId": {
- "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "request": {
- "$ref": "AccountReturnCarrier"
- },
- "response": {
- "$ref": "AccountReturnCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "authinfo": {
+ "description": "Returns information about the authenticated user.",
+ "flatPath": "accounts/authinfo",
+ "httpMethod": "GET",
+ "id": "content.accounts.authinfo",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "accounts/authinfo",
+ "response": {
+ "$ref": "AccountsAuthInfoResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "claimwebsite": {
+ "description": "Claims the website of a Merchant Center sub-account.",
+ "flatPath": "{merchantId}/accounts/{accountId}/claimwebsite",
+ "httpMethod": "POST",
+ "id": "content.accounts.claimwebsite",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account whose website is claimed.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "overwrite": {
+ "description": "Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.",
+ "location": "query",
+ "type": "boolean"
}
- },
- "accountstatuses": {
- "methods": {
- "custombatch": {
- "description": "Retrieves multiple Merchant Center account statuses in a single request.",
- "flatPath": "accountstatuses/batch",
- "httpMethod": "POST",
- "id": "content.accountstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accountstatuses/batch",
- "request": {
- "$ref": "AccountstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
- "flatPath": "{merchantId}/accountstatuses/{accountId}",
- "httpMethod": "GET",
- "id": "content.accountstatuses.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accountstatuses/{accountId}",
- "response": {
- "$ref": "AccountStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accountstatuses",
- "httpMethod": "GET",
- "id": "content.accountstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of account statuses to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accountstatuses",
- "response": {
- "$ref": "AccountstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}/claimwebsite",
+ "response": {
+ "$ref": "AccountsClaimWebsiteResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "custombatch": {
+ "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
+ "flatPath": "accounts/batch",
+ "httpMethod": "POST",
+ "id": "content.accounts.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "accounts/batch",
+ "request": {
+ "$ref": "AccountsCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "AccountsCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a Merchant Center sub-account.",
+ "flatPath": "{merchantId}/accounts/{accountId}",
+ "httpMethod": "DELETE",
+ "id": "content.accounts.delete",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "force": {
+ "default": "false",
+ "description": "Flag to delete sub-accounts with products. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accounttax": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
- "flatPath": "accounttax/batch",
- "httpMethod": "POST",
- "id": "content.accounttax.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounttax/batch",
- "request": {
- "$ref": "AccounttaxCustomBatchRequest"
- },
- "response": {
- "$ref": "AccounttaxCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the tax settings of the account.",
- "flatPath": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "GET",
- "id": "content.accounttax.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax/{accountId}",
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accounttax",
- "httpMethod": "GET",
- "id": "content.accounttax.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of tax settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax",
- "response": {
- "$ref": "AccounttaxListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "PUT",
- "id": "content.accounttax.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax/{accountId}",
- "request": {
- "$ref": "AccountTax"
- },
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a Merchant Center account.",
+ "flatPath": "{merchantId}/accounts/{accountId}",
+ "httpMethod": "GET",
+ "id": "content.accounts.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
+ "enum": [
+ "MERCHANT",
+ "CSS"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "buyongoogleprograms": {
- "methods": {
- "get": {
- "description": "Retrieves a status of BoG program for your Merchant Center account.",
- "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}",
- "httpMethod": "GET",
- "id": "content.buyongoogleprograms.get",
- "parameterOrder": [
- "merchantId",
- "regionCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionCode": {
- "description": "The Program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/buyongoogleprograms/{regionCode}",
- "response": {
- "$ref": "BuyOnGoogleProgramStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "onboard": {
- "description": "Onboards BoG in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.",
- "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
- "httpMethod": "POST",
- "id": "content.buyongoogleprograms.onboard",
- "parameterOrder": [
- "merchantId",
- "regionCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionCode": {
- "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
- "request": {
- "$ref": "OnboardBuyOnGoogleProgramRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Creates a Merchant Center sub-account.",
+ "flatPath": "{merchantId}/accounts",
+ "httpMethod": "POST",
+ "id": "content.accounts.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "collections": {
- "methods": {
- "create": {
- "description": "Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.",
- "flatPath": "{merchantId}/collections",
- "httpMethod": "POST",
- "id": "content.collections.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections",
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collections/{collectionId}",
- "httpMethod": "DELETE",
- "id": "content.collections.delete",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections/{collectionId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collections/{collectionId}",
- "httpMethod": "GET",
- "id": "content.collections.get",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections/{collectionId}",
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.",
- "flatPath": "{merchantId}/collections",
- "httpMethod": "GET",
- "id": "content.collections.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/collections",
- "response": {
- "$ref": "ListCollectionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "link": {
+ "description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
+ "flatPath": "{merchantId}/accounts/{accountId}/link",
+ "httpMethod": "POST",
+ "id": "content.accounts.link",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account that should be linked.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "collectionstatuses": {
- "methods": {
- "get": {
- "description": "Gets the status of a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collectionstatuses/{collectionId}",
- "httpMethod": "GET",
- "id": "content.collectionstatuses.get",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collectionstatuses/{collectionId}",
- "response": {
- "$ref": "CollectionStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the collections in your Merchant Center account.",
- "flatPath": "{merchantId}/collectionstatuses",
- "httpMethod": "GET",
- "id": "content.collectionstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/collectionstatuses",
- "response": {
- "$ref": "ListCollectionStatusesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}/link",
+ "request": {
+ "$ref": "AccountsLinkRequest"
+ },
+ "response": {
+ "$ref": "AccountsLinkResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the sub-accounts in your Merchant Center account.",
+ "flatPath": "{merchantId}/accounts",
+ "httpMethod": "GET",
+ "id": "content.accounts.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "label": {
+ "description": "If view is set to \"css\", only return accounts that are assigned label with given ID.",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of accounts to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
+ "enum": [
+ "MERCHANT",
+ "CSS"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "csses": {
- "methods": {
- "get": {
- "description": "Retrieves a single CSS domain by ID.",
- "flatPath": "{cssGroupId}/csses/{cssDomainId}",
- "httpMethod": "GET",
- "id": "content.csses.get",
- "parameterOrder": [
- "cssGroupId",
- "cssDomainId"
- ],
- "parameters": {
- "cssDomainId": {
- "description": "Required. The ID of the CSS domain to return.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses/{cssDomainId}",
- "response": {
- "$ref": "Css"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists CSS domains affiliated with a CSS group.",
- "flatPath": "{cssGroupId}/csses",
- "httpMethod": "GET",
- "id": "content.csses.list",
- "parameterOrder": [
- "cssGroupId"
- ],
- "parameters": {
- "cssGroupId": {
- "description": "Required. The CSS group ID of CSS domains to be listed.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses",
- "response": {
- "$ref": "ListCssesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatelabels": {
- "description": "Updates labels that are assigned to a CSS domain by its CSS group.",
- "flatPath": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
- "httpMethod": "POST",
- "id": "content.csses.updatelabels",
- "parameterOrder": [
- "cssGroupId",
- "cssDomainId"
- ],
- "parameters": {
- "cssDomainId": {
- "description": "Required. The ID of the updated CSS domain.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Required. The CSS group ID of the updated CSS domain.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
- "request": {
- "$ref": "LabelIds"
- },
- "response": {
- "$ref": "Css"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts",
+ "response": {
+ "$ref": "AccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "listlinks": {
+ "description": "Returns the list of accounts linked to your Merchant Center account.",
+ "flatPath": "{merchantId}/accounts/{accountId}/listlinks",
+ "httpMethod": "GET",
+ "id": "content.accounts.listlinks",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to list links.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
}
- },
- "datafeeds": {
- "methods": {
- "custombatch": {
- "description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
- "flatPath": "datafeeds/batch",
- "httpMethod": "POST",
- "id": "content.datafeeds.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "datafeeds/batch",
- "request": {
- "$ref": "DatafeedsCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a datafeed configuration from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "DELETE",
- "id": "content.datafeeds.delete",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "fetchnow": {
- "description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
- "httpMethod": "POST",
- "id": "content.datafeeds.fetchnow",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed to be fetched.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
- "response": {
- "$ref": "DatafeedsFetchNowResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a datafeed configuration from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "GET",
- "id": "content.datafeeds.get",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Registers a datafeed configuration with your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds",
- "httpMethod": "POST",
- "id": "content.datafeeds.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds",
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the configurations for datafeeds in your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds",
- "httpMethod": "GET",
- "id": "content.datafeeds.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds",
- "response": {
- "$ref": "DatafeedsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "PUT",
- "id": "content.datafeeds.update",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}/listlinks",
+ "response": {
+ "$ref": "AccountsListLinksResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "{merchantId}/accounts/{accountId}",
+ "httpMethod": "PUT",
+ "id": "content.accounts.update",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "datafeedstatuses": {
- "methods": {
- "custombatch": {
- "description": "Gets multiple Merchant Center datafeed statuses in a single request.",
- "flatPath": "datafeedstatuses/batch",
- "httpMethod": "POST",
- "id": "content.datafeedstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "datafeedstatuses/batch",
- "request": {
- "$ref": "DatafeedstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the status of a datafeed from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeedstatuses/{datafeedId}",
- "httpMethod": "GET",
- "id": "content.datafeedstatuses.get",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "country": {
- "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
- "location": "query",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "language": {
- "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeedstatuses/{datafeedId}",
- "response": {
- "$ref": "DatafeedStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
- "flatPath": "{merchantId}/datafeedstatuses",
- "httpMethod": "GET",
- "id": "content.datafeedstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeedstatuses",
- "response": {
- "$ref": "DatafeedstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounts/{accountId}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "updatelabels": {
+ "description": "Updates labels that are assigned to the Merchant Center account by CSS user.",
+ "flatPath": "{merchantId}/accounts/{accountId}/updatelabels",
+ "httpMethod": "POST",
+ "id": "content.accounts.updatelabels",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account whose labels are updated.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "liasettings": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
- "flatPath": "liasettings/batch",
- "httpMethod": "POST",
- "id": "content.liasettings.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "liasettings/batch",
- "request": {
- "$ref": "LiasettingsCustomBatchRequest"
- },
- "response": {
- "$ref": "LiasettingsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the LIA settings of the account.",
- "flatPath": "{merchantId}/liasettings/{accountId}",
- "httpMethod": "GET",
- "id": "content.liasettings.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get or update LIA settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}",
- "response": {
- "$ref": "LiaSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getaccessiblegmbaccounts": {
- "description": "Retrieves the list of accessible Google My Business accounts.",
- "flatPath": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
- "httpMethod": "GET",
- "id": "content.liasettings.getaccessiblegmbaccounts",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
- "response": {
- "$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/liasettings",
- "httpMethod": "GET",
- "id": "content.liasettings.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of LIA settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings",
- "response": {
- "$ref": "LiasettingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ },
+ "path": "{merchantId}/accounts/{accountId}/updatelabels",
+ "request": {
+ "$ref": "AccountsUpdateLabelsRequest"
+ },
+ "response": {
+ "$ref": "AccountsUpdateLabelsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ },
+ "resources": {
+ "credentials": {
+ "methods": {
+ "create": {
+ "description": "Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.",
+ "flatPath": "accounts/{accountId}/credentials",
+ "httpMethod": "POST",
+ "id": "content.accounts.credentials.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The merchant id of the account these credentials belong to.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/credentials",
+ "request": {
+ "$ref": "AccountCredentials"
+ },
+ "response": {
+ "$ref": "AccountCredentials"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "labels": {
+ "methods": {
+ "create": {
+ "description": "Creates a new label, not assigned to any account.",
+ "flatPath": "accounts/{accountId}/labels",
+ "httpMethod": "POST",
+ "id": "content.accounts.labels.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The id of the account this label belongs to.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/labels",
+ "request": {
+ "$ref": "AccountLabel"
+ },
+ "response": {
+ "$ref": "AccountLabel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a label and removes it from all accounts to which it was assigned.",
+ "flatPath": "accounts/{accountId}/labels/{labelId}",
+ "httpMethod": "DELETE",
+ "id": "content.accounts.labels.delete",
+ "parameterOrder": [
+ "accountId",
+ "labelId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The id of the account that owns the label.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "listposdataproviders": {
- "description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
- "flatPath": "liasettings/posdataproviders",
- "httpMethod": "GET",
- "id": "content.liasettings.listposdataproviders",
- "parameterOrder": [],
- "parameters": {},
- "path": "liasettings/posdataproviders",
- "response": {
- "$ref": "LiasettingsListPosDataProvidersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ "labelId": {
+ "description": "Required. The id of the label to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/labels/{labelId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the labels assigned to an account.",
+ "flatPath": "accounts/{accountId}/labels",
+ "httpMethod": "GET",
+ "id": "content.accounts.labels.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The account id for whose labels are to be listed.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "requestgmbaccess": {
- "description": "Requests access to a specified Google My Business account.",
- "flatPath": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
- "httpMethod": "POST",
- "id": "content.liasettings.requestgmbaccess",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "gmbEmail"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which GMB access is requested.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "gmbEmail": {
- "description": "The email of the Google My Business account.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
- "response": {
- "$ref": "LiasettingsRequestGmbAccessResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ "pageSize": {
+ "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
- "requestinventoryverification": {
- "description": "Requests inventory validation for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
- "httpMethod": "POST",
- "id": "content.liasettings.requestinventoryverification",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which inventory validation is requested.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
- "response": {
- "$ref": "LiasettingsRequestInventoryVerificationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ "pageToken": {
+ "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/labels",
+ "response": {
+ "$ref": "ListAccountLabelsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "patch": {
+ "description": "Updates a label.",
+ "flatPath": "accounts/{accountId}/labels/{labelId}",
+ "httpMethod": "PATCH",
+ "id": "content.accounts.labels.patch",
+ "parameterOrder": [
+ "accountId",
+ "labelId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The id of the account this label belongs to.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "setinventoryverificationcontact": {
- "description": "Sets the inventory verification contract for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
- "httpMethod": "POST",
- "id": "content.liasettings.setinventoryverificationcontact",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country",
- "language",
- "contactName",
- "contactEmail"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "contactEmail": {
- "description": "The email of the inventory verification contact.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "contactName": {
- "description": "The name of the inventory verification contact.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which inventory verification is requested.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "language": {
- "description": "The language for which inventory verification is requested.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
- "response": {
- "$ref": "LiasettingsSetInventoryVerificationContactResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ "labelId": {
+ "description": "Required. The id of the label to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/labels/{labelId}",
+ "request": {
+ "$ref": "AccountLabel"
+ },
+ "response": {
+ "$ref": "AccountLabel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "returncarrier": {
+ "methods": {
+ "create": {
+ "description": "Links return carrier to a merchant account.",
+ "flatPath": "accounts/{accountId}/returncarrier",
+ "httpMethod": "POST",
+ "id": "content.accounts.returncarrier.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/returncarrier",
+ "request": {
+ "$ref": "AccountReturnCarrier"
+ },
+ "response": {
+ "$ref": "AccountReturnCarrier"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Delete a return carrier in the merchant account.",
+ "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
+ "httpMethod": "DELETE",
+ "id": "content.accounts.returncarrier.delete",
+ "parameterOrder": [
+ "accountId",
+ "carrierAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "setposdataprovider": {
- "description": "Sets the POS data provider for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/setposdataprovider",
- "httpMethod": "POST",
- "id": "content.liasettings.setposdataprovider",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which the POS data provider is selected.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "posDataProviderId": {
- "description": "The ID of POS data provider.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS data provider.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/setposdataprovider",
- "response": {
- "$ref": "LiasettingsSetPosDataProviderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
+ "carrierAccountId": {
+ "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists available return carriers in the merchant account.",
+ "flatPath": "accounts/{accountId}/returncarrier",
+ "httpMethod": "GET",
+ "id": "content.accounts.returncarrier.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/returncarrier",
+ "response": {
+ "$ref": "ListAccountReturnCarrierResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "patch": {
+ "description": "Updates a return carrier in the merchant account.",
+ "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
+ "httpMethod": "PATCH",
+ "id": "content.accounts.returncarrier.patch",
+ "parameterOrder": [
+ "accountId",
+ "carrierAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "update": {
- "description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/liasettings/{accountId}",
- "httpMethod": "PUT",
- "id": "content.liasettings.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get or update LIA settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}",
- "request": {
- "$ref": "LiaSettings"
- },
- "response": {
- "$ref": "LiaSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ "carrierAccountId": {
+ "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
+ "request": {
+ "$ref": "AccountReturnCarrier"
+ },
+ "response": {
+ "$ref": "AccountReturnCarrier"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
}
- },
- "localinventory": {
- "methods": {
- "custombatch": {
- "description": "Updates local inventory for multiple products or stores in a single request.",
- "flatPath": "localinventory/batch",
- "httpMethod": "POST",
- "id": "content.localinventory.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "localinventory/batch",
- "request": {
- "$ref": "LocalinventoryCustomBatchRequest"
- },
- "response": {
- "$ref": "LocalinventoryCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Updates the local inventory of a product in your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}/localinventory",
- "httpMethod": "POST",
- "id": "content.localinventory.insert",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product for which to update local inventory.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}/localinventory",
- "request": {
- "$ref": "LocalInventory"
- },
- "response": {
- "$ref": "LocalInventory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ }
+ }
+ }
+ },
+ "accountstatuses": {
+ "methods": {
+ "custombatch": {
+ "description": "Retrieves multiple Merchant Center account statuses in a single request.",
+ "flatPath": "accountstatuses/batch",
+ "httpMethod": "POST",
+ "id": "content.accountstatuses.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "accountstatuses/batch",
+ "request": {
+ "$ref": "AccountstatusesCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "AccountstatusesCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
+ "flatPath": "{merchantId}/accountstatuses/{accountId}",
+ "httpMethod": "GET",
+ "id": "content.accountstatuses.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "orderinvoices": {
- "methods": {
- "createchargeinvoice": {
- "description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
- "flatPath": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
- "httpMethod": "POST",
- "id": "content.orderinvoices.createchargeinvoice",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
- "request": {
- "$ref": "OrderinvoicesCreateChargeInvoiceRequest"
- },
- "response": {
- "$ref": "OrderinvoicesCreateChargeInvoiceResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createrefundinvoice": {
- "description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.",
- "flatPath": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
- "httpMethod": "POST",
- "id": "content.orderinvoices.createrefundinvoice",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
- "request": {
- "$ref": "OrderinvoicesCreateRefundInvoiceRequest"
- },
- "response": {
- "$ref": "OrderinvoicesCreateRefundInvoiceResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accountstatuses/{accountId}",
+ "response": {
+ "$ref": "AccountStatus"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
+ "flatPath": "{merchantId}/accountstatuses",
+ "httpMethod": "GET",
+ "id": "content.accountstatuses.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of account statuses to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
}
- },
- "orderreports": {
- "methods": {
- "listdisbursements": {
- "description": "Retrieves a report for disbursements from your Merchant Center account.",
- "flatPath": "{merchantId}/orderreports/disbursements",
- "httpMethod": "GET",
- "id": "content.orderreports.listdisbursements",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "disbursementEndDate": {
- "description": "The last date which disbursements occurred. In ISO 8601 format. Default: current date.",
- "location": "query",
- "type": "string"
- },
- "disbursementStartDate": {
- "description": "The first date which disbursements occurred. In ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of disbursements to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreports/disbursements",
- "response": {
- "$ref": "OrderreportsListDisbursementsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "listtransactions": {
- "description": "Retrieves a list of transactions for a disbursement from your Merchant Center account.",
- "flatPath": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
- "httpMethod": "GET",
- "id": "content.orderreports.listtransactions",
- "parameterOrder": [
- "merchantId",
- "disbursementId"
- ],
- "parameters": {
- "disbursementId": {
- "description": "The Google-provided ID of the disbursement (found in Wallet).",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of disbursements to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "transactionEndDate": {
- "description": "The last date in which transaction occurred. In ISO 8601 format. Default: current date.",
- "location": "query",
- "type": "string"
- },
- "transactionStartDate": {
- "description": "The first date in which transaction occurred. In ISO 8601 format.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
- "response": {
- "$ref": "OrderreportsListTransactionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accountstatuses",
+ "response": {
+ "$ref": "AccountstatusesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "accounttax": {
+ "methods": {
+ "custombatch": {
+ "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
+ "flatPath": "accounttax/batch",
+ "httpMethod": "POST",
+ "id": "content.accounttax.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "accounttax/batch",
+ "request": {
+ "$ref": "AccounttaxCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "AccounttaxCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the tax settings of the account.",
+ "flatPath": "{merchantId}/accounttax/{accountId}",
+ "httpMethod": "GET",
+ "id": "content.accounttax.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "orderreturns": {
- "methods": {
- "acknowledge": {
- "description": "Acks an order return in your Merchant Center account.",
- "flatPath": "{merchantId}/orderreturns/{returnId}/acknowledge",
- "httpMethod": "POST",
- "id": "content.orderreturns.acknowledge",
- "parameterOrder": [
- "merchantId",
- "returnId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnId": {
- "description": "The ID of the return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreturns/{returnId}/acknowledge",
- "request": {
- "$ref": "OrderreturnsAcknowledgeRequest"
- },
- "response": {
- "$ref": "OrderreturnsAcknowledgeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createorderreturn": {
- "description": "Create return in your Merchant Center account.",
- "flatPath": "{merchantId}/orderreturns/createOrderReturn",
- "httpMethod": "POST",
- "id": "content.orderreturns.createorderreturn",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreturns/createOrderReturn",
- "request": {
- "$ref": "OrderreturnsCreateOrderReturnRequest"
- },
- "response": {
- "$ref": "OrderreturnsCreateOrderReturnResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves an order return from your Merchant Center account.",
- "flatPath": "{merchantId}/orderreturns/{returnId}",
- "httpMethod": "GET",
- "id": "content.orderreturns.get",
- "parameterOrder": [
- "merchantId",
- "returnId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnId": {
- "description": "Merchant order return ID generated by Google.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreturns/{returnId}",
- "response": {
- "$ref": "MerchantOrderReturn"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists order returns in your Merchant Center account.",
- "flatPath": "{merchantId}/orderreturns",
- "httpMethod": "GET",
- "id": "content.orderreturns.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "acknowledged": {
- "description": "Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned. ",
- "location": "query",
- "type": "boolean"
- },
- "createdEndDate": {
- "description": "Obtains order returns created before this date (inclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "createdStartDate": {
- "description": "Obtains order returns created after this date (inclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "googleOrderIds": {
- "description": "Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderBy": {
- "description": "Return the results in the specified order.",
- "enum": [
- "RETURN_CREATION_TIME_DESC",
- "RETURN_CREATION_TIME_ASC"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "shipmentStates": {
- "description": "Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.",
- "enum": [
- "NEW",
- "SHIPPED",
- "COMPLETED",
- "UNDELIVERABLE",
- "PENDING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "shipmentStatus": {
- "description": "Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.",
- "enum": [
- "NEW",
- "IN_PROGRESS",
- "PROCESSED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "shipmentTrackingNumbers": {
- "description": "Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "shipmentTypes": {
- "description": "Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.",
- "enum": [
- "BY_MAIL",
- "RETURNLESS",
- "CONTACT_CUSTOMER_SUPPORT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreturns",
- "response": {
- "$ref": "OrderreturnsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "process": {
- "description": "Processes return in your Merchant Center account.",
- "flatPath": "{merchantId}/orderreturns/{returnId}/process",
- "httpMethod": "POST",
- "id": "content.orderreturns.process",
- "parameterOrder": [
- "merchantId",
- "returnId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnId": {
- "description": "The ID of the return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orderreturns/{returnId}/process",
- "request": {
- "$ref": "OrderreturnsProcessRequest"
- },
- "response": {
- "$ref": "OrderreturnsProcessResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounttax/{accountId}",
+ "response": {
+ "$ref": "AccountTax"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
+ "flatPath": "{merchantId}/accounttax",
+ "httpMethod": "GET",
+ "id": "content.accounttax.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of tax settings to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
}
- },
- "orders": {
- "methods": {
- "acknowledge": {
- "description": "Marks an order as acknowledged.",
- "flatPath": "{merchantId}/orders/{orderId}/acknowledge",
- "httpMethod": "POST",
- "id": "content.orders.acknowledge",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/acknowledge",
- "request": {
- "$ref": "OrdersAcknowledgeRequest"
- },
- "response": {
- "$ref": "OrdersAcknowledgeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "advancetestorder": {
- "description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\".",
- "flatPath": "{merchantId}/testorders/{orderId}/advance",
- "httpMethod": "POST",
- "id": "content.orders.advancetestorder",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the test order to modify.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/testorders/{orderId}/advance",
- "response": {
- "$ref": "OrdersAdvanceTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancel": {
- "description": "Cancels all line items in an order, making a full refund.",
- "flatPath": "{merchantId}/orders/{orderId}/cancel",
- "httpMethod": "POST",
- "id": "content.orders.cancel",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order to cancel.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/cancel",
- "request": {
- "$ref": "OrdersCancelRequest"
- },
- "response": {
- "$ref": "OrdersCancelResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancellineitem": {
- "description": "Cancels a line item, making a full refund.",
- "flatPath": "{merchantId}/orders/{orderId}/cancelLineItem",
- "httpMethod": "POST",
- "id": "content.orders.cancellineitem",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/cancelLineItem",
- "request": {
- "$ref": "OrdersCancelLineItemRequest"
- },
- "response": {
- "$ref": "OrdersCancelLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "canceltestorderbycustomer": {
- "description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
- "flatPath": "{merchantId}/testorders/{orderId}/cancelByCustomer",
- "httpMethod": "POST",
- "id": "content.orders.canceltestorderbycustomer",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the test order to cancel.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/testorders/{orderId}/cancelByCustomer",
- "request": {
- "$ref": "OrdersCancelTestOrderByCustomerRequest"
- },
- "response": {
- "$ref": "OrdersCancelTestOrderByCustomerResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createtestorder": {
- "description": "Sandbox only. Creates a test order.",
- "flatPath": "{merchantId}/testorders",
- "httpMethod": "POST",
- "id": "content.orders.createtestorder",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/testorders",
- "request": {
- "$ref": "OrdersCreateTestOrderRequest"
- },
- "response": {
- "$ref": "OrdersCreateTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createtestreturn": {
- "description": "Sandbox only. Creates a test return.",
- "flatPath": "{merchantId}/orders/{orderId}/testreturn",
- "httpMethod": "POST",
- "id": "content.orders.createtestreturn",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/testreturn",
- "request": {
- "$ref": "OrdersCreateTestReturnRequest"
- },
- "response": {
- "$ref": "OrdersCreateTestReturnResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves an order from your Merchant Center account.",
- "flatPath": "{merchantId}/orders/{orderId}",
- "httpMethod": "GET",
- "id": "content.orders.get",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}",
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getbymerchantorderid": {
- "description": "Retrieves an order using merchant order ID.",
- "flatPath": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- "httpMethod": "GET",
- "id": "content.orders.getbymerchantorderid",
- "parameterOrder": [
- "merchantId",
- "merchantOrderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantOrderId": {
- "description": "The merchant order ID to be looked for.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- "response": {
- "$ref": "OrdersGetByMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "gettestordertemplate": {
- "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
- "flatPath": "{merchantId}/testordertemplates/{templateName}",
- "httpMethod": "GET",
- "id": "content.orders.gettestordertemplate",
- "parameterOrder": [
- "merchantId",
- "templateName"
- ],
- "parameters": {
- "country": {
- "description": "The country of the template to retrieve. Defaults to `US`.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "templateName": {
- "description": "The name of the template to retrieve.",
- "enum": [
- "TEMPLATE1",
- "TEMPLATE2",
- "TEMPLATE1A",
- "TEMPLATE1B",
- "TEMPLATE3",
- "TEMPLATE4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/testordertemplates/{templateName}",
- "response": {
- "$ref": "OrdersGetTestOrderTemplateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "instorerefundlineitem": {
- "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.",
- "flatPath": "{merchantId}/orders/{orderId}/inStoreRefundLineItem",
- "httpMethod": "POST",
- "id": "content.orders.instorerefundlineitem",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/inStoreRefundLineItem",
- "request": {
- "$ref": "OrdersInStoreRefundLineItemRequest"
- },
- "response": {
- "$ref": "OrdersInStoreRefundLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the orders in your Merchant Center account.",
- "flatPath": "{merchantId}/orders",
- "httpMethod": "GET",
- "id": "content.orders.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "acknowledged": {
- "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderBy": {
- "description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "placedDateEnd": {
- "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "placedDateStart": {
- "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "statuses": {
- "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.",
- "enum": [
- "ACTIVE",
- "COMPLETED",
- "CANCELED",
- "IN_PROGRESS",
- "PENDING_SHIPMENT",
- "PARTIALLY_SHIPPED",
- "SHIPPED",
- "PARTIALLY_DELIVERED",
- "DELIVERED",
- "PARTIALLY_RETURNED",
- "RETURNED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders",
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "refunditem": {
- "description": "Issues a partial or total refund for items and shipment.",
- "flatPath": "{merchantId}/orders/{orderId}/refunditem",
- "httpMethod": "POST",
- "id": "content.orders.refunditem",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order to refund.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/refunditem",
- "request": {
- "$ref": "OrdersRefundItemRequest"
- },
- "response": {
- "$ref": "OrdersRefundItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "refundorder": {
- "description": "Issues a partial or total refund for an order.",
- "flatPath": "{merchantId}/orders/{orderId}/refundorder",
- "httpMethod": "POST",
- "id": "content.orders.refundorder",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order to refund.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/refundorder",
- "request": {
- "$ref": "OrdersRefundOrderRequest"
- },
- "response": {
- "$ref": "OrdersRefundOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "rejectreturnlineitem": {
- "description": "Rejects return on an line item.",
- "flatPath": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
- "httpMethod": "POST",
- "id": "content.orders.rejectreturnlineitem",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
- "request": {
- "$ref": "OrdersRejectReturnLineItemRequest"
- },
- "response": {
- "$ref": "OrdersRejectReturnLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "returnrefundlineitem": {
- "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.",
- "flatPath": "{merchantId}/orders/{orderId}/returnRefundLineItem",
- "httpMethod": "POST",
- "id": "content.orders.returnrefundlineitem",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/returnRefundLineItem",
- "request": {
- "$ref": "OrdersReturnRefundLineItemRequest"
- },
- "response": {
- "$ref": "OrdersReturnRefundLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "setlineitemmetadata": {
- "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.",
- "flatPath": "{merchantId}/orders/{orderId}/setLineItemMetadata",
- "httpMethod": "POST",
- "id": "content.orders.setlineitemmetadata",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/setLineItemMetadata",
- "request": {
- "$ref": "OrdersSetLineItemMetadataRequest"
- },
- "response": {
- "$ref": "OrdersSetLineItemMetadataResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "shiplineitems": {
- "description": "Marks line item(s) as shipped.",
- "flatPath": "{merchantId}/orders/{orderId}/shipLineItems",
- "httpMethod": "POST",
- "id": "content.orders.shiplineitems",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/shipLineItems",
- "request": {
- "$ref": "OrdersShipLineItemsRequest"
- },
- "response": {
- "$ref": "OrdersShipLineItemsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatelineitemshippingdetails": {
- "description": "Updates ship by and delivery by dates for a line item.",
- "flatPath": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
- "httpMethod": "POST",
- "id": "content.orders.updatelineitemshippingdetails",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
- "request": {
- "$ref": "OrdersUpdateLineItemShippingDetailsRequest"
- },
- "response": {
- "$ref": "OrdersUpdateLineItemShippingDetailsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatemerchantorderid": {
- "description": "Updates the merchant order ID for a given order.",
- "flatPath": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- "httpMethod": "POST",
- "id": "content.orders.updatemerchantorderid",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- "request": {
- "$ref": "OrdersUpdateMerchantOrderIdRequest"
- },
- "response": {
- "$ref": "OrdersUpdateMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updateshipment": {
- "description": "Updates a shipment's status, carrier, and/or tracking ID.",
- "flatPath": "{merchantId}/orders/{orderId}/updateShipment",
- "httpMethod": "POST",
- "id": "content.orders.updateshipment",
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/orders/{orderId}/updateShipment",
- "request": {
- "$ref": "OrdersUpdateShipmentRequest"
- },
- "response": {
- "$ref": "OrdersUpdateShipmentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounttax",
+ "response": {
+ "$ref": "AccounttaxListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "{merchantId}/accounttax/{accountId}",
+ "httpMethod": "PUT",
+ "id": "content.accounttax.update",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "ordertrackingsignals": {
- "methods": {
- "create": {
- "description": "Creates new order tracking signal.",
- "flatPath": "{merchantId}/ordertrackingsignals",
- "httpMethod": "POST",
- "id": "content.ordertrackingsignals.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the merchant for which the order signal is created.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/ordertrackingsignals",
- "request": {
- "$ref": "OrderTrackingSignal"
- },
- "response": {
- "$ref": "OrderTrackingSignal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/accounttax/{accountId}",
+ "request": {
+ "$ref": "AccountTax"
+ },
+ "response": {
+ "$ref": "AccountTax"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "buyongoogleprograms": {
+ "methods": {
+ "activate": {
+ "description": "Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, e.g. when paused. Important: This method is only whitelisted for selected merchants.",
+ "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/activate",
+ "httpMethod": "POST",
+ "id": "content.buyongoogleprograms.activate",
+ "parameterOrder": [
+ "merchantId",
+ "regionCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "pos": {
- "methods": {
- "custombatch": {
- "description": "Batches multiple POS-related calls in a single request.",
- "flatPath": "pos/batch",
- "httpMethod": "POST",
- "id": "content.pos.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "pos/batch",
- "request": {
- "$ref": "PosCustomBatchRequest"
- },
- "response": {
- "$ref": "PosCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a store for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "httpMethod": "DELETE",
- "id": "content.pos.delete",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId",
- "storeCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "storeCode": {
- "description": "A store code that is unique per merchant.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves information about the given store.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "httpMethod": "GET",
- "id": "content.pos.get",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId",
- "storeCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "storeCode": {
- "description": "A store code that is unique per merchant.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "response": {
- "$ref": "PosStore"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Creates a store for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
- "httpMethod": "POST",
- "id": "content.pos.insert",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store",
- "request": {
- "$ref": "PosStore"
- },
- "response": {
- "$ref": "PosStore"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "inventory": {
- "description": "Submit inventory for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/inventory",
- "httpMethod": "POST",
- "id": "content.pos.inventory",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/inventory",
- "request": {
- "$ref": "PosInventoryRequest"
- },
- "response": {
- "$ref": "PosInventoryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the stores of the target merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
- "httpMethod": "GET",
- "id": "content.pos.list",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store",
- "response": {
- "$ref": "PosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "sale": {
- "description": "Submit a sale event for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/sale",
- "httpMethod": "POST",
- "id": "content.pos.sale",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/sale",
- "request": {
- "$ref": "PosSaleRequest"
- },
- "response": {
- "$ref": "PosSaleResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/buyongoogleprograms/{regionCode}/activate",
+ "request": {
+ "$ref": "ActivateBuyOnGoogleProgramRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a status of the BoG program for your Merchant Center account.",
+ "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}",
+ "httpMethod": "GET",
+ "id": "content.buyongoogleprograms.get",
+ "parameterOrder": [
+ "merchantId",
+ "regionCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The Program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "products": {
- "methods": {
- "custombatch": {
- "description": "Retrieves, inserts, and deletes multiple products in a single request.",
- "flatPath": "products/batch",
- "httpMethod": "POST",
- "id": "content.products.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "products/batch",
- "request": {
- "$ref": "ProductsCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a product from your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}",
- "httpMethod": "DELETE",
- "id": "content.products.delete",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "feedId": {
- "description": "The Content API Supplemental Feed ID.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a product from your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}",
- "httpMethod": "GET",
- "id": "content.products.get",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}",
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
- "flatPath": "{merchantId}/products",
- "httpMethod": "POST",
- "id": "content.products.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "feedId": {
- "description": "The Content API Supplemental Feed ID.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products",
- "request": {
- "$ref": "Product"
- },
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
- "flatPath": "{merchantId}/products",
- "httpMethod": "GET",
- "id": "content.products.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/products",
- "response": {
- "$ref": "ProductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/buyongoogleprograms/{regionCode}",
+ "response": {
+ "$ref": "BuyOnGoogleProgramStatus"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "onboard": {
+ "description": "Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.",
+ "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
+ "httpMethod": "POST",
+ "id": "content.buyongoogleprograms.onboard",
+ "parameterOrder": [
+ "merchantId",
+ "regionCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "productstatuses": {
- "methods": {
- "custombatch": {
- "description": "Gets the statuses of multiple products in a single request.",
- "flatPath": "productstatuses/batch",
- "httpMethod": "POST",
- "id": "content.productstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "productstatuses/batch",
- "request": {
- "$ref": "ProductstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets the status of a product from your Merchant Center account.",
- "flatPath": "{merchantId}/productstatuses/{productId}",
- "httpMethod": "GET",
- "id": "content.productstatuses.get",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/productstatuses/{productId}",
- "response": {
- "$ref": "ProductStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the products in your Merchant Center account.",
- "flatPath": "{merchantId}/productstatuses",
- "httpMethod": "GET",
- "id": "content.productstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of product statuses to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/productstatuses",
- "response": {
- "$ref": "ProductstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- },
- "resources": {
- "repricingreports": {
- "methods": {
- "list": {
- "description": "Lists the metrics report for a given Repricing product.",
- "flatPath": "{merchantId}/productstatuses/{productId}/repricingreports",
- "httpMethod": "GET",
- "id": "content.productstatuses.repricingreports.list",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "endDate": {
- "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format is YYYY-MM-DD.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. Id of the merchant who owns the Repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a page_size of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the page size.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- },
- "productId": {
- "description": "Required. Id of the Repricing product. Also known as the [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id)",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ruleId": {
- "description": "Id of the Repricing rule. If specified, only gets this rule's reports.",
- "location": "query",
- "type": "string"
- },
- "startDate": {
- "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format is YYYY-MM-DD.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/productstatuses/{productId}/repricingreports",
- "response": {
- "$ref": "ListRepricingProductReportsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
+ },
+ "path": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
+ "request": {
+ "$ref": "OnboardBuyOnGoogleProgramRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "pause": {
+ "description": "Pauses the BoG program in your Merchant Center account. Important: This method is only whitelisted for selected merchants.",
+ "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/pause",
+ "httpMethod": "POST",
+ "id": "content.buyongoogleprograms.pause",
+ "parameterOrder": [
+ "merchantId",
+ "regionCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "pubsubnotificationsettings": {
- "methods": {
- "get": {
- "description": "Retrieves a Merchant Center account's pubsub notification settings.",
- "flatPath": "{merchantId}/pubsubnotificationsettings",
- "httpMethod": "GET",
- "id": "content.pubsubnotificationsettings.get",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to get pubsub notification settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pubsubnotificationsettings",
- "response": {
- "$ref": "PubsubNotificationSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.",
- "flatPath": "{merchantId}/pubsubnotificationsettings",
- "httpMethod": "PUT",
- "id": "content.pubsubnotificationsettings.update",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pubsubnotificationsettings",
- "request": {
- "$ref": "PubsubNotificationSettings"
- },
- "response": {
- "$ref": "PubsubNotificationSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/buyongoogleprograms/{regionCode}/pause",
+ "request": {
+ "$ref": "PauseBuyOnGoogleProgramRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "requestreview": {
+ "description": "Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. Important: This method is only whitelisted for selected merchants.",
+ "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/requestreview",
+ "httpMethod": "POST",
+ "id": "content.buyongoogleprograms.requestreview",
+ "parameterOrder": [
+ "merchantId",
+ "regionCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "regionalinventory": {
- "methods": {
- "custombatch": {
- "description": "Updates regional inventory for multiple products or regions in a single request.",
- "flatPath": "regionalinventory/batch",
- "httpMethod": "POST",
- "id": "content.regionalinventory.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "regionalinventory/batch",
- "request": {
- "$ref": "RegionalinventoryCustomBatchRequest"
- },
- "response": {
- "$ref": "RegionalinventoryCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.",
- "flatPath": "{merchantId}/products/{productId}/regionalinventory",
- "httpMethod": "POST",
- "id": "content.regionalinventory.insert",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product for which to update the regional inventory.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}/regionalinventory",
- "request": {
- "$ref": "RegionalInventory"
- },
- "response": {
- "$ref": "RegionalInventory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/buyongoogleprograms/{regionCode}/requestreview",
+ "request": {
+ "$ref": "RequestReviewBuyOnGoogleProgramRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "collections": {
+ "methods": {
+ "create": {
+ "description": "Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.",
+ "flatPath": "{merchantId}/collections",
+ "httpMethod": "POST",
+ "id": "content.collections.create",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "regions": {
- "methods": {
- "create": {
- "description": "Creates a region definition in your Merchant Center account.",
- "flatPath": "{merchantId}/regions",
- "httpMethod": "POST",
- "id": "content.regions.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to create region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to create.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions",
- "request": {
- "$ref": "Region"
- },
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a region definition from your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "DELETE",
- "id": "content.regions.delete",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to delete region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a region defined in your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "GET",
- "id": "content.regions.get",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the regions in your Merchant Center account.",
- "flatPath": "{merchantId}/regions",
- "httpMethod": "GET",
- "id": "content.regions.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to list region definitions.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions",
- "response": {
- "$ref": "ListRegionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a region definition in your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "PATCH",
- "id": "content.regions.patch",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to update region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to update.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Optional. The field mask indicating the fields to update.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "request": {
- "$ref": "Region"
- },
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/collections",
+ "request": {
+ "$ref": "Collection"
+ },
+ "response": {
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a collection from your Merchant Center account.",
+ "flatPath": "{merchantId}/collections/{collectionId}",
+ "httpMethod": "DELETE",
+ "id": "content.collections.delete",
+ "parameterOrder": [
+ "merchantId",
+ "collectionId"
+ ],
+ "parameters": {
+ "collectionId": {
+ "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "reports": {
- "methods": {
- "search": {
- "description": "Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.",
- "flatPath": "{merchantId}/reports/search",
- "httpMethod": "POST",
- "id": "content.reports.search",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/reports/search",
- "request": {
- "$ref": "SearchRequest"
- },
- "response": {
- "$ref": "SearchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/collections/{collectionId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a collection from your Merchant Center account.",
+ "flatPath": "{merchantId}/collections/{collectionId}",
+ "httpMethod": "GET",
+ "id": "content.collections.get",
+ "parameterOrder": [
+ "merchantId",
+ "collectionId"
+ ],
+ "parameters": {
+ "collectionId": {
+ "description": "Required. The REST ID of the collection.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "repricingrules": {
- "methods": {
- "create": {
- "description": "Creates a repricing rule for your Merchant Center account.",
- "flatPath": "{merchantId}/repricingrules",
- "httpMethod": "POST",
- "id": "content.repricingrules.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant who owns the repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ruleId": {
- "description": "Required. The id of the rule to create.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules",
- "request": {
- "$ref": "RepricingRule"
- },
- "response": {
- "$ref": "RepricingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a repricing rule in your Merchant Center account.",
- "flatPath": "{merchantId}/repricingrules/{ruleId}",
- "httpMethod": "DELETE",
- "id": "content.repricingrules.delete",
- "parameterOrder": [
- "merchantId",
- "ruleId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant who owns the repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ruleId": {
- "description": "Required. The id of the rule to Delete.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules/{ruleId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a repricing rule from your Merchant Center account.",
- "flatPath": "{merchantId}/repricingrules/{ruleId}",
- "httpMethod": "GET",
- "id": "content.repricingrules.get",
- "parameterOrder": [
- "merchantId",
- "ruleId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant who owns the repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ruleId": {
- "description": "Required. The id of the rule to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules/{ruleId}",
- "response": {
- "$ref": "RepricingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the repricing rules in your Merchant Center account.",
- "flatPath": "{merchantId}/repricingrules",
- "httpMethod": "GET",
- "id": "content.repricingrules.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "countryCode": {
- "description": "[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\"), used as a filter on repricing rules.",
- "location": "query",
- "type": "string"
- },
- "languageCode": {
- "description": "The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The id of the merchant who owns the repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of repricing rules to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListRepricingRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepricingRules` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules",
- "response": {
- "$ref": "ListRepricingRulesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.",
- "flatPath": "{merchantId}/repricingrules/{ruleId}",
- "httpMethod": "PATCH",
- "id": "content.repricingrules.patch",
- "parameterOrder": [
- "merchantId",
- "ruleId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant who owns the repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ruleId": {
- "description": "Required. The id of the rule to update.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules/{ruleId}",
- "request": {
- "$ref": "RepricingRule"
- },
- "response": {
- "$ref": "RepricingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- },
- "resources": {
- "repricingreports": {
- "methods": {
- "list": {
- "description": "Lists the metrics report for a given Repricing rule.",
- "flatPath": "{merchantId}/repricingrules/{ruleId}/repricingreports",
- "httpMethod": "GET",
- "id": "content.repricingrules.repricingreports.list",
- "parameterOrder": [
- "merchantId",
- "ruleId"
- ],
- "parameters": {
- "endDate": {
- "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. Id of the merchant who owns the Repricing rule.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- },
- "ruleId": {
- "description": "Required. Id of the Repricing rule.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "startDate": {
- "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/repricingrules/{ruleId}/repricingreports",
- "response": {
- "$ref": "ListRepricingRuleReportsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
+ },
+ "path": "{merchantId}/collections/{collectionId}",
+ "response": {
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.",
+ "flatPath": "{merchantId}/collections",
+ "httpMethod": "GET",
+ "id": "content.collections.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
+ "location": "query",
+ "type": "string"
}
- },
- "returnaddress": {
- "methods": {
- "custombatch": {
- "description": "Batches multiple return address related calls in a single request.",
- "flatPath": "returnaddress/batch",
- "httpMethod": "POST",
- "id": "content.returnaddress.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "returnaddress/batch",
- "request": {
- "$ref": "ReturnaddressCustomBatchRequest"
- },
- "response": {
- "$ref": "ReturnaddressCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a return address for the given Merchant Center account.",
- "flatPath": "{merchantId}/returnaddress/{returnAddressId}",
- "httpMethod": "DELETE",
- "id": "content.returnaddress.delete",
- "parameterOrder": [
- "merchantId",
- "returnAddressId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account from which to delete the given return address.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnAddressId": {
- "description": "Return address ID generated by Google.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnaddress/{returnAddressId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets a return address of the Merchant Center account.",
- "flatPath": "{merchantId}/returnaddress/{returnAddressId}",
- "httpMethod": "GET",
- "id": "content.returnaddress.get",
- "parameterOrder": [
- "merchantId",
- "returnAddressId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account to get a return address for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnAddressId": {
- "description": "Return address ID generated by Google.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnaddress/{returnAddressId}",
- "response": {
- "$ref": "ReturnAddress"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Inserts a return address for the Merchant Center account.",
- "flatPath": "{merchantId}/returnaddress",
- "httpMethod": "POST",
- "id": "content.returnaddress.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account to insert a return address for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnaddress",
- "request": {
- "$ref": "ReturnAddress"
- },
- "response": {
- "$ref": "ReturnAddress"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the return addresses of the Merchant Center account.",
- "flatPath": "{merchantId}/returnaddress",
- "httpMethod": "GET",
- "id": "content.returnaddress.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "country": {
- "description": "List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of addresses in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The Merchant Center account to list return addresses for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/returnaddress",
- "response": {
- "$ref": "ReturnaddressListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/collections",
+ "response": {
+ "$ref": "ListCollectionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "collectionstatuses": {
+ "methods": {
+ "get": {
+ "description": "Gets the status of a collection from your Merchant Center account.",
+ "flatPath": "{merchantId}/collectionstatuses/{collectionId}",
+ "httpMethod": "GET",
+ "id": "content.collectionstatuses.get",
+ "parameterOrder": [
+ "merchantId",
+ "collectionId"
+ ],
+ "parameters": {
+ "collectionId": {
+ "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "returnpolicy": {
- "methods": {
- "custombatch": {
- "description": "Batches multiple return policy related calls in a single request.",
- "flatPath": "returnpolicy/batch",
- "httpMethod": "POST",
- "id": "content.returnpolicy.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "returnpolicy/batch",
- "request": {
- "$ref": "ReturnpolicyCustomBatchRequest"
- },
- "response": {
- "$ref": "ReturnpolicyCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a return policy for the given Merchant Center account.",
- "flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
- "httpMethod": "DELETE",
- "id": "content.returnpolicy.delete",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account from which to delete the given return policy.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Return policy ID generated by Google.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicy/{returnPolicyId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets a return policy of the Merchant Center account.",
- "flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
- "httpMethod": "GET",
- "id": "content.returnpolicy.get",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account to get a return policy for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Return policy ID generated by Google.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicy/{returnPolicyId}",
- "response": {
- "$ref": "ReturnPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Inserts a return policy for the Merchant Center account.",
- "flatPath": "{merchantId}/returnpolicy",
- "httpMethod": "POST",
- "id": "content.returnpolicy.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account to insert a return policy for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicy",
- "request": {
- "$ref": "ReturnPolicy"
- },
- "response": {
- "$ref": "ReturnPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the return policies of the Merchant Center account.",
- "flatPath": "{merchantId}/returnpolicy",
- "httpMethod": "GET",
- "id": "content.returnpolicy.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account to list return policies for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicy",
- "response": {
- "$ref": "ReturnpolicyListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/collectionstatuses/{collectionId}",
+ "response": {
+ "$ref": "CollectionStatus"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the statuses of the collections in your Merchant Center account.",
+ "flatPath": "{merchantId}/collectionstatuses",
+ "httpMethod": "GET",
+ "id": "content.collectionstatuses.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
+ "location": "query",
+ "type": "string"
}
- },
- "returnpolicyonline": {
- "methods": {
- "create": {
- "description": "Creates a new return policy.",
- "flatPath": "{merchantId}/returnpolicyonline",
- "httpMethod": "POST",
- "id": "content.returnpolicyonline.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline",
- "request": {
- "$ref": "ReturnPolicyOnline"
- },
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "DELETE",
- "id": "content.returnpolicyonline.delete",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "GET",
- "id": "content.returnpolicyonline.get",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists all existing return policies.",
- "flatPath": "{merchantId}/returnpolicyonline",
- "httpMethod": "GET",
- "id": "content.returnpolicyonline.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline",
- "response": {
- "$ref": "ListReturnPolicyOnlineResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "PATCH",
- "id": "content.returnpolicyonline.patch",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to update.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "request": {
- "$ref": "ReturnPolicyOnline"
- },
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{merchantId}/collectionstatuses",
+ "response": {
+ "$ref": "ListCollectionStatusesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "csses": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a single CSS domain by ID.",
+ "flatPath": "{cssGroupId}/csses/{cssDomainId}",
+ "httpMethod": "GET",
+ "id": "content.csses.get",
+ "parameterOrder": [
+ "cssGroupId",
+ "cssDomainId"
+ ],
+ "parameters": {
+ "cssDomainId": {
+ "description": "Required. The ID of the CSS domain to return.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "cssGroupId": {
+ "description": "Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "settlementreports": {
- "methods": {
- "get": {
- "description": "Retrieves a settlement report from your Merchant Center account.",
- "flatPath": "{merchantId}/settlementreports/{settlementId}",
- "httpMethod": "GET",
- "id": "content.settlementreports.get",
- "parameterOrder": [
- "merchantId",
- "settlementId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Merchant Center account of the settlement report.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "settlementId": {
- "description": "The Google-provided ID of the settlement.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/settlementreports/{settlementId}",
- "response": {
- "$ref": "SettlementReport"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Retrieves a list of settlement reports from your Merchant Center account.",
- "flatPath": "{merchantId}/settlementreports",
- "httpMethod": "GET",
- "id": "content.settlementreports.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The Merchant Center account to list settlements for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "transferEndDate": {
- "description": "Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- },
- "transferStartDate": {
- "description": "Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/settlementreports",
- "response": {
- "$ref": "SettlementreportsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{cssGroupId}/csses/{cssDomainId}",
+ "response": {
+ "$ref": "Css"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists CSS domains affiliated with a CSS group.",
+ "flatPath": "{cssGroupId}/csses",
+ "httpMethod": "GET",
+ "id": "content.csses.list",
+ "parameterOrder": [
+ "cssGroupId"
+ ],
+ "parameters": {
+ "cssGroupId": {
+ "description": "Required. The CSS group ID of CSS domains to be listed.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A page token, received from a previous `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
}
- },
- "settlementtransactions": {
- "methods": {
- "list": {
- "description": "Retrieves a list of transactions for the settlement.",
- "flatPath": "{merchantId}/settlementreports/{settlementId}/transactions",
- "httpMethod": "GET",
- "id": "content.settlementtransactions.list",
- "parameterOrder": [
- "merchantId",
- "settlementId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The Merchant Center account to list transactions for.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "settlementId": {
- "description": "The Google-provided ID of the settlement.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "transactionIds": {
- "description": "The list of transactions to return. If not set, all transactions will be returned.",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/settlementreports/{settlementId}/transactions",
- "response": {
- "$ref": "SettlementtransactionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{cssGroupId}/csses",
+ "response": {
+ "$ref": "ListCssesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "updatelabels": {
+ "description": "Updates labels that are assigned to a CSS domain by its CSS group.",
+ "flatPath": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
+ "httpMethod": "POST",
+ "id": "content.csses.updatelabels",
+ "parameterOrder": [
+ "cssGroupId",
+ "cssDomainId"
+ ],
+ "parameters": {
+ "cssDomainId": {
+ "description": "Required. The ID of the updated CSS domain.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "cssGroupId": {
+ "description": "Required. The CSS group ID of the updated CSS domain.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "shippingsettings": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
- "flatPath": "shippingsettings/batch",
- "httpMethod": "POST",
- "id": "content.shippingsettings.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "shippingsettings/batch",
- "request": {
- "$ref": "ShippingsettingsCustomBatchRequest"
- },
- "response": {
- "$ref": "ShippingsettingsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the shipping settings of the account.",
- "flatPath": "{merchantId}/shippingsettings/{accountId}",
- "httpMethod": "GET",
- "id": "content.shippingsettings.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update shipping settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings/{accountId}",
- "response": {
- "$ref": "ShippingSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedcarriers": {
- "description": "Retrieves supported carriers and carrier services for an account.",
- "flatPath": "{merchantId}/supportedCarriers",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedcarriers",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported carriers.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedCarriers",
- "response": {
- "$ref": "ShippingsettingsGetSupportedCarriersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedholidays": {
- "description": "Retrieves supported holidays for an account.",
- "flatPath": "{merchantId}/supportedHolidays",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedholidays",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported holidays.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedHolidays",
- "response": {
- "$ref": "ShippingsettingsGetSupportedHolidaysResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedpickupservices": {
- "description": "Retrieves supported pickup services for an account.",
- "flatPath": "{merchantId}/supportedPickupServices",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedpickupservices",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported pickup services.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedPickupServices",
- "response": {
- "$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/shippingsettings",
- "httpMethod": "GET",
- "id": "content.shippingsettings.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of shipping settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings",
- "response": {
- "$ref": "ShippingsettingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/shippingsettings/{accountId}",
- "httpMethod": "PUT",
- "id": "content.shippingsettings.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update shipping settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings/{accountId}",
- "request": {
- "$ref": "ShippingSettings"
- },
- "response": {
- "$ref": "ShippingSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
+ },
+ "path": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
+ "request": {
+ "$ref": "LabelIds"
+ },
+ "response": {
+ "$ref": "Css"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "datafeeds": {
+ "methods": {
+ "custombatch": {
+ "description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
+ "flatPath": "datafeeds/batch",
+ "httpMethod": "POST",
+ "id": "content.datafeeds.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "datafeeds/batch",
+ "request": {
+ "$ref": "DatafeedsCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "DatafeedsCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a datafeed configuration from your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeeds/{datafeedId}",
+ "httpMethod": "DELETE",
+ "id": "content.datafeeds.delete",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "datafeedId": {
+ "description": "The ID of the datafeed.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeeds/{datafeedId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "fetchnow": {
+ "description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.",
+ "flatPath": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
+ "httpMethod": "POST",
+ "id": "content.datafeeds.fetchnow",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "datafeedId": {
+ "description": "The ID of the datafeed to be fetched.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
+ "response": {
+ "$ref": "DatafeedsFetchNowResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a datafeed configuration from your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeeds/{datafeedId}",
+ "httpMethod": "GET",
+ "id": "content.datafeeds.get",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "datafeedId": {
+ "description": "The ID of the datafeed.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeeds/{datafeedId}",
+ "response": {
+ "$ref": "Datafeed"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Registers a datafeed configuration with your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeeds",
+ "httpMethod": "POST",
+ "id": "content.datafeeds.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeeds",
+ "request": {
+ "$ref": "Datafeed"
+ },
+ "response": {
+ "$ref": "Datafeed"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the configurations for datafeeds in your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeeds",
+ "httpMethod": "GET",
+ "id": "content.datafeeds.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeeds",
+ "response": {
+ "$ref": "DatafeedsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "{merchantId}/datafeeds/{datafeedId}",
+ "httpMethod": "PUT",
+ "id": "content.datafeeds.update",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "datafeedId": {
+ "description": "The ID of the datafeed.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "{merchantId}/datafeeds/{datafeedId}",
+ "request": {
+ "$ref": "Datafeed"
+ },
+ "response": {
+ "$ref": "Datafeed"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
}
+ }
},
- "revision": "20210311",
- "rootUrl": "https://shoppingcontent.googleapis.com/",
- "schemas": {
- "Account": {
- "description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.",
- "id": "Account",
- "properties": {
- "adsLinks": {
- "description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.",
- "items": {
- "$ref": "AccountAdsLink"
- },
- "type": "array"
- },
- "adultContent": {
- "description": "Indicates whether the merchant sells adult content.",
- "type": "boolean"
- },
- "automaticLabelIds": {
- "description": "Automatically created label IDs that are assigned to the account by CSS Center.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "businessInformation": {
- "$ref": "AccountBusinessInformation",
- "description": "The business information of the account."
- },
- "cssId": {
- "description": "ID of CSS the account belongs to.",
- "format": "uint64",
- "type": "string"
- },
- "googleMyBusinessLink": {
- "$ref": "AccountGoogleMyBusinessLink",
- "description": "The GMB account which is linked or in the process of being linked with the Merchant Center account."
- },
- "id": {
- "description": "Required for update. Merchant Center account ID.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\"",
- "type": "string"
- },
- "labelIds": {
- "description": "Manually created label IDs that are assigned to the account by CSS.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Required. Display name for the account.",
- "type": "string"
- },
- "sellerId": {
- "description": "Client-specific, locally-unique, internal ID for the child account.",
- "type": "string"
- },
- "users": {
- "description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
- "items": {
- "$ref": "AccountUser"
- },
- "type": "array"
- },
- "websiteUrl": {
- "description": "The merchant's website.",
- "type": "string"
+ "datafeedstatuses": {
+ "methods": {
+ "custombatch": {
+ "description": "Gets multiple Merchant Center datafeed statuses in a single request.",
+ "flatPath": "datafeedstatuses/batch",
+ "httpMethod": "POST",
+ "id": "content.datafeedstatuses.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "datafeedstatuses/batch",
+ "request": {
+ "$ref": "DatafeedstatusesCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "DatafeedstatusesCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the status of a datafeed from your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeedstatuses/{datafeedId}",
+ "httpMethod": "GET",
+ "id": "content.datafeedstatuses.get",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "country": {
+ "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
+ "location": "query",
+ "type": "string"
+ },
+ "datafeedId": {
+ "description": "The ID of the datafeed.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeedstatuses/{datafeedId}",
+ "response": {
+ "$ref": "DatafeedStatus"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
+ "flatPath": "{merchantId}/datafeedstatuses",
+ "httpMethod": "GET",
+ "id": "content.datafeedstatuses.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/datafeedstatuses",
+ "response": {
+ "$ref": "DatafeedstatusesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "liasettings": {
+ "methods": {
+ "custombatch": {
+ "description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
+ "flatPath": "liasettings/batch",
+ "httpMethod": "POST",
+ "id": "content.liasettings.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "liasettings/batch",
+ "request": {
+ "$ref": "LiasettingsCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "LiasettingsCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the LIA settings of the account.",
+ "flatPath": "{merchantId}/liasettings/{accountId}",
+ "httpMethod": "GET",
+ "id": "content.liasettings.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get or update LIA settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}",
+ "response": {
+ "$ref": "LiaSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getaccessiblegmbaccounts": {
+ "description": "Retrieves the list of accessible Google My Business accounts.",
+ "flatPath": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
+ "httpMethod": "GET",
+ "id": "content.liasettings.getaccessiblegmbaccounts",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
+ "response": {
+ "$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
+ "flatPath": "{merchantId}/liasettings",
+ "httpMethod": "GET",
+ "id": "content.liasettings.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of LIA settings to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings",
+ "response": {
+ "$ref": "LiasettingsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "listposdataproviders": {
+ "description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
+ "flatPath": "liasettings/posdataproviders",
+ "httpMethod": "GET",
+ "id": "content.liasettings.listposdataproviders",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "liasettings/posdataproviders",
+ "response": {
+ "$ref": "LiasettingsListPosDataProvidersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "requestgmbaccess": {
+ "description": "Requests access to a specified Google My Business account.",
+ "flatPath": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
+ "httpMethod": "POST",
+ "id": "content.liasettings.requestgmbaccess",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "gmbEmail"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which GMB access is requested.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "gmbEmail": {
+ "description": "The email of the Google My Business account.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
+ "response": {
+ "$ref": "LiasettingsRequestGmbAccessResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "requestinventoryverification": {
+ "description": "Requests inventory validation for the specified country.",
+ "flatPath": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
+ "httpMethod": "POST",
+ "id": "content.liasettings.requestinventoryverification",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "The country for which inventory validation is requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
+ "response": {
+ "$ref": "LiasettingsRequestInventoryVerificationResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "setinventoryverificationcontact": {
+ "description": "Sets the inventory verification contract for the specified country.",
+ "flatPath": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
+ "httpMethod": "POST",
+ "id": "content.liasettings.setinventoryverificationcontact",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country",
+ "language",
+ "contactName",
+ "contactEmail"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "contactEmail": {
+ "description": "The email of the inventory verification contact.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "contactName": {
+ "description": "The name of the inventory verification contact.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "The country for which inventory verification is requested.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "The language for which inventory verification is requested.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
+ "response": {
+ "$ref": "LiasettingsSetInventoryVerificationContactResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "setposdataprovider": {
+ "description": "Sets the POS data provider for the specified country.",
+ "flatPath": "{merchantId}/liasettings/{accountId}/setposdataprovider",
+ "httpMethod": "POST",
+ "id": "content.liasettings.setposdataprovider",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "The country for which the POS data provider is selected.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "posDataProviderId": {
+ "description": "The ID of POS data provider.",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "posExternalAccountId": {
+ "description": "The account ID by which this merchant is known to the POS data provider.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}/setposdataprovider",
+ "response": {
+ "$ref": "LiasettingsSetPosDataProviderResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "{merchantId}/liasettings/{accountId}",
+ "httpMethod": "PUT",
+ "id": "content.liasettings.update",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get or update LIA settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/liasettings/{accountId}",
+ "request": {
+ "$ref": "LiaSettings"
+ },
+ "response": {
+ "$ref": "LiaSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "localinventory": {
+ "methods": {
+ "custombatch": {
+ "description": "Updates local inventory for multiple products or stores in a single request.",
+ "flatPath": "localinventory/batch",
+ "httpMethod": "POST",
+ "id": "content.localinventory.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "localinventory/batch",
+ "request": {
+ "$ref": "LocalinventoryCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "LocalinventoryCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Updates the local inventory of a product in your Merchant Center account.",
+ "flatPath": "{merchantId}/products/{productId}/localinventory",
+ "httpMethod": "POST",
+ "id": "content.localinventory.insert",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product for which to update local inventory.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products/{productId}/localinventory",
+ "request": {
+ "$ref": "LocalInventory"
+ },
+ "response": {
+ "$ref": "LocalInventory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "orderinvoices": {
+ "methods": {
+ "createchargeinvoice": {
+ "description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
+ "flatPath": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
+ "httpMethod": "POST",
+ "id": "content.orderinvoices.createchargeinvoice",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
+ "request": {
+ "$ref": "OrderinvoicesCreateChargeInvoiceRequest"
+ },
+ "response": {
+ "$ref": "OrderinvoicesCreateChargeInvoiceResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "createrefundinvoice": {
+ "description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.",
+ "flatPath": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
+ "httpMethod": "POST",
+ "id": "content.orderinvoices.createrefundinvoice",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
+ "request": {
+ "$ref": "OrderinvoicesCreateRefundInvoiceRequest"
+ },
+ "response": {
+ "$ref": "OrderinvoicesCreateRefundInvoiceResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "orderreports": {
+ "methods": {
+ "listdisbursements": {
+ "description": "Retrieves a report for disbursements from your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreports/disbursements",
+ "httpMethod": "GET",
+ "id": "content.orderreports.listdisbursements",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "disbursementEndDate": {
+ "description": "The last date which disbursements occurred. In ISO 8601 format. Default: current date.",
+ "location": "query",
+ "type": "string"
+ },
+ "disbursementStartDate": {
+ "description": "The first date which disbursements occurred. In ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of disbursements to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreports/disbursements",
+ "response": {
+ "$ref": "OrderreportsListDisbursementsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "listtransactions": {
+ "description": "Retrieves a list of transactions for a disbursement from your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
+ "httpMethod": "GET",
+ "id": "content.orderreports.listtransactions",
+ "parameterOrder": [
+ "merchantId",
+ "disbursementId"
+ ],
+ "parameters": {
+ "disbursementId": {
+ "description": "The Google-provided ID of the disbursement (found in Wallet).",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of disbursements to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "transactionEndDate": {
+ "description": "The last date in which transaction occurred. In ISO 8601 format. Default: current date.",
+ "location": "query",
+ "type": "string"
+ },
+ "transactionStartDate": {
+ "description": "The first date in which transaction occurred. In ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
+ "response": {
+ "$ref": "OrderreportsListTransactionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "orderreturns": {
+ "methods": {
+ "acknowledge": {
+ "description": "Acks an order return in your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreturns/{returnId}/acknowledge",
+ "httpMethod": "POST",
+ "id": "content.orderreturns.acknowledge",
+ "parameterOrder": [
+ "merchantId",
+ "returnId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnId": {
+ "description": "The ID of the return.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns/{returnId}/acknowledge",
+ "request": {
+ "$ref": "OrderreturnsAcknowledgeRequest"
+ },
+ "response": {
+ "$ref": "OrderreturnsAcknowledgeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "createorderreturn": {
+ "description": "Create return in your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreturns/createOrderReturn",
+ "httpMethod": "POST",
+ "id": "content.orderreturns.createorderreturn",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns/createOrderReturn",
+ "request": {
+ "$ref": "OrderreturnsCreateOrderReturnRequest"
+ },
+ "response": {
+ "$ref": "OrderreturnsCreateOrderReturnResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves an order return from your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreturns/{returnId}",
+ "httpMethod": "GET",
+ "id": "content.orderreturns.get",
+ "parameterOrder": [
+ "merchantId",
+ "returnId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnId": {
+ "description": "Merchant order return ID generated by Google.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns/{returnId}",
+ "response": {
+ "$ref": "MerchantOrderReturn"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists order returns in your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreturns",
+ "httpMethod": "GET",
+ "id": "content.orderreturns.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "acknowledged": {
+ "description": "Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned. ",
+ "location": "query",
+ "type": "boolean"
+ },
+ "createdEndDate": {
+ "description": "Obtains order returns created before this date (inclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "createdStartDate": {
+ "description": "Obtains order returns created after this date (inclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "googleOrderIds": {
+ "description": "Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Return the results in the specified order.",
+ "enum": [
+ "RETURN_CREATION_TIME_DESC",
+ "RETURN_CREATION_TIME_ASC"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "shipmentStates": {
+ "description": "Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.",
+ "enum": [
+ "NEW",
+ "SHIPPED",
+ "COMPLETED",
+ "UNDELIVERABLE",
+ "PENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "shipmentStatus": {
+ "description": "Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.",
+ "enum": [
+ "NEW",
+ "IN_PROGRESS",
+ "PROCESSED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "shipmentTrackingNumbers": {
+ "description": "Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "shipmentTypes": {
+ "description": "Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.",
+ "enum": [
+ "BY_MAIL",
+ "RETURNLESS",
+ "CONTACT_CUSTOMER_SUPPORT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns",
+ "response": {
+ "$ref": "OrderreturnsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "process": {
+ "description": "Processes return in your Merchant Center account.",
+ "flatPath": "{merchantId}/orderreturns/{returnId}/process",
+ "httpMethod": "POST",
+ "id": "content.orderreturns.process",
+ "parameterOrder": [
+ "merchantId",
+ "returnId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnId": {
+ "description": "The ID of the return.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns/{returnId}/process",
+ "request": {
+ "$ref": "OrderreturnsProcessRequest"
+ },
+ "response": {
+ "$ref": "OrderreturnsProcessResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ },
+ "resources": {
+ "labels": {
+ "methods": {
+ "create": {
+ "description": "Links a return shipping label to a return id. You can only create one return label per return id. Since the label is sent to the buyer, the linked return label cannot be updated or deleted. If you try to create multiple return shipping labels for a single return id, every create request except the first will fail.",
+ "flatPath": "{merchantId}/orderreturns/{returnId}/labels",
+ "httpMethod": "POST",
+ "id": "content.orderreturns.labels.create",
+ "parameterOrder": [
+ "merchantId",
+ "returnId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The merchant the Return Shipping Label belongs to.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "youtubeChannelLinks": {
- "description": "Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
- "items": {
- "$ref": "AccountYouTubeChannelLink"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountAddress": {
- "id": "AccountAddress",
- "properties": {
- "country": {
- "description": "CLDR country code (e.g. \"US\"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.",
- "type": "string"
+ "returnId": {
+ "description": "Required. Provide the Google-generated merchant order return ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orderreturns/{returnId}/labels",
+ "request": {
+ "$ref": "ReturnShippingLabel"
+ },
+ "response": {
+ "$ref": "ReturnShippingLabel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "orders": {
+ "methods": {
+ "acknowledge": {
+ "description": "Marks an order as acknowledged.",
+ "flatPath": "{merchantId}/orders/{orderId}/acknowledge",
+ "httpMethod": "POST",
+ "id": "content.orders.acknowledge",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/acknowledge",
+ "request": {
+ "$ref": "OrdersAcknowledgeRequest"
+ },
+ "response": {
+ "$ref": "OrdersAcknowledgeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "advancetestorder": {
+ "description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\".",
+ "flatPath": "{merchantId}/testorders/{orderId}/advance",
+ "httpMethod": "POST",
+ "id": "content.orders.advancetestorder",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the test order to modify.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/testorders/{orderId}/advance",
+ "response": {
+ "$ref": "OrdersAdvanceTestOrderResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "cancel": {
+ "description": "Cancels all line items in an order, making a full refund.",
+ "flatPath": "{merchantId}/orders/{orderId}/cancel",
+ "httpMethod": "POST",
+ "id": "content.orders.cancel",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order to cancel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/cancel",
+ "request": {
+ "$ref": "OrdersCancelRequest"
+ },
+ "response": {
+ "$ref": "OrdersCancelResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "cancellineitem": {
+ "description": "Cancels a line item, making a full refund.",
+ "flatPath": "{merchantId}/orders/{orderId}/cancelLineItem",
+ "httpMethod": "POST",
+ "id": "content.orders.cancellineitem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/cancelLineItem",
+ "request": {
+ "$ref": "OrdersCancelLineItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersCancelLineItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "canceltestorderbycustomer": {
+ "description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
+ "flatPath": "{merchantId}/testorders/{orderId}/cancelByCustomer",
+ "httpMethod": "POST",
+ "id": "content.orders.canceltestorderbycustomer",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the test order to cancel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/testorders/{orderId}/cancelByCustomer",
+ "request": {
+ "$ref": "OrdersCancelTestOrderByCustomerRequest"
+ },
+ "response": {
+ "$ref": "OrdersCancelTestOrderByCustomerResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "createtestorder": {
+ "description": "Sandbox only. Creates a test order.",
+ "flatPath": "{merchantId}/testorders",
+ "httpMethod": "POST",
+ "id": "content.orders.createtestorder",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/testorders",
+ "request": {
+ "$ref": "OrdersCreateTestOrderRequest"
+ },
+ "response": {
+ "$ref": "OrdersCreateTestOrderResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "createtestreturn": {
+ "description": "Sandbox only. Creates a test return.",
+ "flatPath": "{merchantId}/orders/{orderId}/testreturn",
+ "httpMethod": "POST",
+ "id": "content.orders.createtestreturn",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/testreturn",
+ "request": {
+ "$ref": "OrdersCreateTestReturnRequest"
+ },
+ "response": {
+ "$ref": "OrdersCreateTestReturnResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves an order from your Merchant Center account.",
+ "flatPath": "{merchantId}/orders/{orderId}",
+ "httpMethod": "GET",
+ "id": "content.orders.get",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}",
+ "response": {
+ "$ref": "Order"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getbymerchantorderid": {
+ "description": "Retrieves an order using merchant order ID.",
+ "flatPath": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
+ "httpMethod": "GET",
+ "id": "content.orders.getbymerchantorderid",
+ "parameterOrder": [
+ "merchantId",
+ "merchantOrderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "description": "The merchant order ID to be looked for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
+ "response": {
+ "$ref": "OrdersGetByMerchantOrderIdResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "gettestordertemplate": {
+ "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
+ "flatPath": "{merchantId}/testordertemplates/{templateName}",
+ "httpMethod": "GET",
+ "id": "content.orders.gettestordertemplate",
+ "parameterOrder": [
+ "merchantId",
+ "templateName"
+ ],
+ "parameters": {
+ "country": {
+ "description": "The country of the template to retrieve. Defaults to `US`.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "templateName": {
+ "description": "The name of the template to retrieve.",
+ "enum": [
+ "TEMPLATE1",
+ "TEMPLATE2",
+ "TEMPLATE1A",
+ "TEMPLATE1B",
+ "TEMPLATE3",
+ "TEMPLATE4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/testordertemplates/{templateName}",
+ "response": {
+ "$ref": "OrdersGetTestOrderTemplateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "instorerefundlineitem": {
+ "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.",
+ "flatPath": "{merchantId}/orders/{orderId}/inStoreRefundLineItem",
+ "httpMethod": "POST",
+ "id": "content.orders.instorerefundlineitem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/inStoreRefundLineItem",
+ "request": {
+ "$ref": "OrdersInStoreRefundLineItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersInStoreRefundLineItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the orders in your Merchant Center account.",
+ "flatPath": "{merchantId}/orders",
+ "httpMethod": "GET",
+ "id": "content.orders.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "acknowledged": {
+ "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "placedDateEnd": {
+ "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "placedDateStart": {
+ "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "statuses": {
+ "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.",
+ "enum": [
+ "ACTIVE",
+ "COMPLETED",
+ "CANCELED",
+ "IN_PROGRESS",
+ "PENDING_SHIPMENT",
+ "PARTIALLY_SHIPPED",
+ "SHIPPED",
+ "PARTIALLY_DELIVERED",
+ "DELIVERED",
+ "PARTIALLY_RETURNED",
+ "RETURNED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders",
+ "response": {
+ "$ref": "OrdersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "refunditem": {
+ "description": "Issues a partial or total refund for items and shipment.",
+ "flatPath": "{merchantId}/orders/{orderId}/refunditem",
+ "httpMethod": "POST",
+ "id": "content.orders.refunditem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order to refund.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/refunditem",
+ "request": {
+ "$ref": "OrdersRefundItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersRefundItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "refundorder": {
+ "description": "Issues a partial or total refund for an order.",
+ "flatPath": "{merchantId}/orders/{orderId}/refundorder",
+ "httpMethod": "POST",
+ "id": "content.orders.refundorder",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order to refund.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/refundorder",
+ "request": {
+ "$ref": "OrdersRefundOrderRequest"
+ },
+ "response": {
+ "$ref": "OrdersRefundOrderResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "rejectreturnlineitem": {
+ "description": "Rejects return on an line item.",
+ "flatPath": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
+ "httpMethod": "POST",
+ "id": "content.orders.rejectreturnlineitem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
+ "request": {
+ "$ref": "OrdersRejectReturnLineItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersRejectReturnLineItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "returnrefundlineitem": {
+ "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.",
+ "flatPath": "{merchantId}/orders/{orderId}/returnRefundLineItem",
+ "httpMethod": "POST",
+ "id": "content.orders.returnrefundlineitem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/returnRefundLineItem",
+ "request": {
+ "$ref": "OrdersReturnRefundLineItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersReturnRefundLineItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "setlineitemmetadata": {
+ "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.",
+ "flatPath": "{merchantId}/orders/{orderId}/setLineItemMetadata",
+ "httpMethod": "POST",
+ "id": "content.orders.setlineitemmetadata",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/setLineItemMetadata",
+ "request": {
+ "$ref": "OrdersSetLineItemMetadataRequest"
+ },
+ "response": {
+ "$ref": "OrdersSetLineItemMetadataResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "shiplineitems": {
+ "description": "Marks line item(s) as shipped.",
+ "flatPath": "{merchantId}/orders/{orderId}/shipLineItems",
+ "httpMethod": "POST",
+ "id": "content.orders.shiplineitems",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/shipLineItems",
+ "request": {
+ "$ref": "OrdersShipLineItemsRequest"
+ },
+ "response": {
+ "$ref": "OrdersShipLineItemsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "updatelineitemshippingdetails": {
+ "description": "Updates ship by and delivery by dates for a line item.",
+ "flatPath": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
+ "httpMethod": "POST",
+ "id": "content.orders.updatelineitemshippingdetails",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
+ "request": {
+ "$ref": "OrdersUpdateLineItemShippingDetailsRequest"
+ },
+ "response": {
+ "$ref": "OrdersUpdateLineItemShippingDetailsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "updatemerchantorderid": {
+ "description": "Updates the merchant order ID for a given order.",
+ "flatPath": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
+ "httpMethod": "POST",
+ "id": "content.orders.updatemerchantorderid",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
+ "request": {
+ "$ref": "OrdersUpdateMerchantOrderIdRequest"
+ },
+ "response": {
+ "$ref": "OrdersUpdateMerchantOrderIdResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "updateshipment": {
+ "description": "Updates a shipment's status, carrier, and/or tracking ID.",
+ "flatPath": "{merchantId}/orders/{orderId}/updateShipment",
+ "httpMethod": "POST",
+ "id": "content.orders.updateshipment",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/orders/{orderId}/updateShipment",
+ "request": {
+ "$ref": "OrdersUpdateShipmentRequest"
+ },
+ "response": {
+ "$ref": "OrdersUpdateShipmentResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "ordertrackingsignals": {
+ "methods": {
+ "create": {
+ "description": "Creates new order tracking signal.",
+ "flatPath": "{merchantId}/ordertrackingsignals",
+ "httpMethod": "POST",
+ "id": "content.ordertrackingsignals.create",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the merchant for which the order signal is created.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/ordertrackingsignals",
+ "request": {
+ "$ref": "OrderTrackingSignal"
+ },
+ "response": {
+ "$ref": "OrderTrackingSignal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "pos": {
+ "methods": {
+ "custombatch": {
+ "description": "Batches multiple POS-related calls in a single request.",
+ "flatPath": "pos/batch",
+ "httpMethod": "POST",
+ "id": "content.pos.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "pos/batch",
+ "request": {
+ "$ref": "PosCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "PosCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a store for the given merchant.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "httpMethod": "DELETE",
+ "id": "content.pos.delete",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId",
+ "storeCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "A store code that is unique per merchant.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves information about the given store.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "httpMethod": "GET",
+ "id": "content.pos.get",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId",
+ "storeCode"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "A store code that is unique per merchant.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "response": {
+ "$ref": "PosStore"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Creates a store for the given merchant.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
+ "httpMethod": "POST",
+ "id": "content.pos.insert",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/store",
+ "request": {
+ "$ref": "PosStore"
+ },
+ "response": {
+ "$ref": "PosStore"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "inventory": {
+ "description": "Submit inventory for the given merchant.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/inventory",
+ "httpMethod": "POST",
+ "id": "content.pos.inventory",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/inventory",
+ "request": {
+ "$ref": "PosInventoryRequest"
+ },
+ "response": {
+ "$ref": "PosInventoryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the stores of the target merchant.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
+ "httpMethod": "GET",
+ "id": "content.pos.list",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/store",
+ "response": {
+ "$ref": "PosListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "sale": {
+ "description": "Submit a sale event for the given merchant.",
+ "flatPath": "{merchantId}/pos/{targetMerchantId}/sale",
+ "httpMethod": "POST",
+ "id": "content.pos.sale",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the target merchant.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pos/{targetMerchantId}/sale",
+ "request": {
+ "$ref": "PosSaleRequest"
+ },
+ "response": {
+ "$ref": "PosSaleResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "products": {
+ "methods": {
+ "custombatch": {
+ "description": "Retrieves, inserts, and deletes multiple products in a single request.",
+ "flatPath": "products/batch",
+ "httpMethod": "POST",
+ "id": "content.products.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "products/batch",
+ "request": {
+ "$ref": "ProductsCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "ProductsCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a product from your Merchant Center account.",
+ "flatPath": "{merchantId}/products/{productId}",
+ "httpMethod": "DELETE",
+ "id": "content.products.delete",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "feedId": {
+ "description": "The Content API Supplemental Feed ID.",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products/{productId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a product from your Merchant Center account.",
+ "flatPath": "{merchantId}/products/{productId}",
+ "httpMethod": "GET",
+ "id": "content.products.get",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products/{productId}",
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
+ "flatPath": "{merchantId}/products",
+ "httpMethod": "POST",
+ "id": "content.products.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "feedId": {
+ "description": "The Content API Supplemental Feed ID.",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products",
+ "request": {
+ "$ref": "Product"
+ },
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
+ "flatPath": "{merchantId}/products",
+ "httpMethod": "GET",
+ "id": "content.products.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products",
+ "response": {
+ "$ref": "ProductsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.",
+ "flatPath": "{merchantId}/products/{productId}",
+ "httpMethod": "PATCH",
+ "id": "content.products.update",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product for which to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "The comma-separated list of product attributes to be updated. Example: `\"title,salePrice\"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products/{productId}",
+ "request": {
+ "$ref": "Product"
+ },
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "productstatuses": {
+ "methods": {
+ "custombatch": {
+ "description": "Gets the statuses of multiple products in a single request.",
+ "flatPath": "productstatuses/batch",
+ "httpMethod": "POST",
+ "id": "content.productstatuses.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "productstatuses/batch",
+ "request": {
+ "$ref": "ProductstatusesCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "ProductstatusesCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Gets the status of a product from your Merchant Center account.",
+ "flatPath": "{merchantId}/productstatuses/{productId}",
+ "httpMethod": "GET",
+ "id": "content.productstatuses.get",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/productstatuses/{productId}",
+ "response": {
+ "$ref": "ProductStatus"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the statuses of the products in your Merchant Center account.",
+ "flatPath": "{merchantId}/productstatuses",
+ "httpMethod": "GET",
+ "id": "content.productstatuses.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of product statuses to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/productstatuses",
+ "response": {
+ "$ref": "ProductstatusesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ },
+ "resources": {
+ "repricingreports": {
+ "methods": {
+ "list": {
+ "description": "Lists the metrics report for a given Repricing product.",
+ "flatPath": "{merchantId}/productstatuses/{productId}/repricingreports",
+ "httpMethod": "GET",
+ "id": "content.productstatuses.repricingreports.list",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "endDate": {
+ "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format is YYYY-MM-DD.",
+ "location": "query",
+ "type": "string"
},
- "locality": {
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
- "type": "string"
+ "merchantId": {
+ "description": "Required. Id of the merchant who owns the Repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "postalCode": {
- "description": "Postal code or ZIP (e.g. \"94043\").",
- "type": "string"
+ "pageSize": {
+ "description": "Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a page_size of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
- "region": {
- "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
+ "pageToken": {
+ "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
+ "location": "query",
+ "type": "string"
},
- "streetAddress": {
- "description": "Street-level part of the address.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountAdsLink": {
- "id": "AccountAdsLink",
- "properties": {
- "adsId": {
- "description": "Customer ID of the Ads account.",
- "format": "uint64",
- "type": "string"
+ "productId": {
+ "description": "Required. Id of the Repricing product. Also known as the [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id)",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "status": {
- "description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountBusinessInformation": {
- "id": "AccountBusinessInformation",
- "properties": {
- "address": {
- "$ref": "AccountAddress",
- "description": "The address of the business."
+ "ruleId": {
+ "description": "Id of the Repricing rule. If specified, only gets this rule's reports.",
+ "location": "query",
+ "type": "string"
},
- "customerService": {
- "$ref": "AccountCustomerService",
- "description": "The customer service information of the business."
+ "startDate": {
+ "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format is YYYY-MM-DD.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/productstatuses/{productId}/repricingreports",
+ "response": {
+ "$ref": "ListRepricingProductReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "pubsubnotificationsettings": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a Merchant Center account's pubsub notification settings.",
+ "flatPath": "{merchantId}/pubsubnotificationsettings",
+ "httpMethod": "GET",
+ "id": "content.pubsubnotificationsettings.get",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account for which to get pubsub notification settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pubsubnotificationsettings",
+ "response": {
+ "$ref": "PubsubNotificationSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.",
+ "flatPath": "{merchantId}/pubsubnotificationsettings",
+ "httpMethod": "PUT",
+ "id": "content.pubsubnotificationsettings.update",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/pubsubnotificationsettings",
+ "request": {
+ "$ref": "PubsubNotificationSettings"
+ },
+ "response": {
+ "$ref": "PubsubNotificationSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "regionalinventory": {
+ "methods": {
+ "custombatch": {
+ "description": "Updates regional inventory for multiple products or regions in a single request.",
+ "flatPath": "regionalinventory/batch",
+ "httpMethod": "POST",
+ "id": "content.regionalinventory.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "regionalinventory/batch",
+ "request": {
+ "$ref": "RegionalinventoryCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "RegionalinventoryCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.",
+ "flatPath": "{merchantId}/products/{productId}/regionalinventory",
+ "httpMethod": "POST",
+ "id": "content.regionalinventory.insert",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The REST ID of the product for which to update the regional inventory.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/products/{productId}/regionalinventory",
+ "request": {
+ "$ref": "RegionalInventory"
+ },
+ "response": {
+ "$ref": "RegionalInventory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "regions": {
+ "methods": {
+ "create": {
+ "description": "Creates a region definition in your Merchant Center account.",
+ "flatPath": "{merchantId}/regions",
+ "httpMethod": "POST",
+ "id": "content.regions.create",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to create region definition.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionId": {
+ "description": "Required. The id of the region to create.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/regions",
+ "request": {
+ "$ref": "Region"
+ },
+ "response": {
+ "$ref": "Region"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a region definition from your Merchant Center account.",
+ "flatPath": "{merchantId}/regions/{regionId}",
+ "httpMethod": "DELETE",
+ "id": "content.regions.delete",
+ "parameterOrder": [
+ "merchantId",
+ "regionId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to delete region definition.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionId": {
+ "description": "Required. The id of the region to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/regions/{regionId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a region defined in your Merchant Center account.",
+ "flatPath": "{merchantId}/regions/{regionId}",
+ "httpMethod": "GET",
+ "id": "content.regions.get",
+ "parameterOrder": [
+ "merchantId",
+ "regionId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve region definition.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionId": {
+ "description": "Required. The id of the region to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/regions/{regionId}",
+ "response": {
+ "$ref": "Region"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the regions in your Merchant Center account.",
+ "flatPath": "{merchantId}/regions",
+ "httpMethod": "GET",
+ "id": "content.regions.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to list region definitions.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/regions",
+ "response": {
+ "$ref": "ListRegionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "patch": {
+ "description": "Updates a region definition in your Merchant Center account.",
+ "flatPath": "{merchantId}/regions/{regionId}",
+ "httpMethod": "PATCH",
+ "id": "content.regions.patch",
+ "parameterOrder": [
+ "merchantId",
+ "regionId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to update region definition.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionId": {
+ "description": "Required. The id of the region to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. The comma-separated field mask indicating the fields to update. Example: `\"displayName,postalCodeArea.regionCode\"`.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/regions/{regionId}",
+ "request": {
+ "$ref": "Region"
+ },
+ "response": {
+ "$ref": "Region"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "search": {
+ "description": "Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.",
+ "flatPath": "{merchantId}/reports/search",
+ "httpMethod": "POST",
+ "id": "content.reports.search",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/reports/search",
+ "request": {
+ "$ref": "SearchRequest"
+ },
+ "response": {
+ "$ref": "SearchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "repricingrules": {
+ "methods": {
+ "create": {
+ "description": "Creates a repricing rule for your Merchant Center account.",
+ "flatPath": "{merchantId}/repricingrules",
+ "httpMethod": "POST",
+ "id": "content.repricingrules.create",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant who owns the repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "Required. The id of the rule to create.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules",
+ "request": {
+ "$ref": "RepricingRule"
+ },
+ "response": {
+ "$ref": "RepricingRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a repricing rule in your Merchant Center account.",
+ "flatPath": "{merchantId}/repricingrules/{ruleId}",
+ "httpMethod": "DELETE",
+ "id": "content.repricingrules.delete",
+ "parameterOrder": [
+ "merchantId",
+ "ruleId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant who owns the repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "Required. The id of the rule to Delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules/{ruleId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a repricing rule from your Merchant Center account.",
+ "flatPath": "{merchantId}/repricingrules/{ruleId}",
+ "httpMethod": "GET",
+ "id": "content.repricingrules.get",
+ "parameterOrder": [
+ "merchantId",
+ "ruleId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant who owns the repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "Required. The id of the rule to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules/{ruleId}",
+ "response": {
+ "$ref": "RepricingRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the repricing rules in your Merchant Center account.",
+ "flatPath": "{merchantId}/repricingrules",
+ "httpMethod": "GET",
+ "id": "content.repricingrules.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "countryCode": {
+ "description": "[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\"), used as a filter on repricing rules.",
+ "location": "query",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Required. The id of the merchant who owns the repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of repricing rules to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A page token, received from a previous `ListRepricingRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepricingRules` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules",
+ "response": {
+ "$ref": "ListRepricingRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "patch": {
+ "description": "Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.",
+ "flatPath": "{merchantId}/repricingrules/{ruleId}",
+ "httpMethod": "PATCH",
+ "id": "content.repricingrules.patch",
+ "parameterOrder": [
+ "merchantId",
+ "ruleId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant who owns the repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "Required. The id of the rule to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules/{ruleId}",
+ "request": {
+ "$ref": "RepricingRule"
+ },
+ "response": {
+ "$ref": "RepricingRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ },
+ "resources": {
+ "repricingreports": {
+ "methods": {
+ "list": {
+ "description": "Lists the metrics report for a given Repricing rule.",
+ "flatPath": "{merchantId}/repricingrules/{ruleId}/repricingreports",
+ "httpMethod": "GET",
+ "id": "content.repricingrules.repricingreports.list",
+ "parameterOrder": [
+ "merchantId",
+ "ruleId"
+ ],
+ "parameters": {
+ "endDate": {
+ "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.",
+ "location": "query",
+ "type": "string"
},
- "phoneNumber": {
- "description": "The phone number of the business.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountCredentials": {
- "description": "Credentials allowing Google to call a partner's API on behalf of a merchant.",
- "id": "AccountCredentials",
- "properties": {
- "accessToken": {
- "description": "An OAuth access token.",
- "type": "string"
+ "merchantId": {
+ "description": "Required. Id of the merchant who owns the Repricing rule.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "expiresIn": {
- "description": "The amount of time, in seconds, after which the access token is no longer valid.",
- "format": "int64",
- "type": "string"
+ "pageSize": {
+ "description": "Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
- "purpose": {
- "description": "Indicates to Google how Google should use these OAuth tokens.",
- "enum": [
- "ACCOUNT_CREDENTIALS_PURPOSE_UNSPECIFIED",
- "SHOPIFY_ORDER_MANAGEMENT"
- ],
- "enumDescriptions": [
- "Unknown purpose.",
- "The credentials allow Google to manage Shopify orders on behalf of the merchant."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountCustomerService": {
- "id": "AccountCustomerService",
- "properties": {
- "email": {
- "description": "Customer service email.",
- "type": "string"
+ "pageToken": {
+ "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
+ "location": "query",
+ "type": "string"
},
- "phoneNumber": {
- "description": "Customer service phone number.",
- "type": "string"
+ "ruleId": {
+ "description": "Required. Id of the Repricing rule.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "url": {
- "description": "Customer service URL.",
- "type": "string"
- }
- },
- "type": "object"
+ "startDate": {
+ "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/repricingrules/{ruleId}/repricingreports",
+ "response": {
+ "$ref": "ListRepricingRuleReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "returnaddress": {
+ "methods": {
+ "custombatch": {
+ "description": "Batches multiple return address related calls in a single request.",
+ "flatPath": "returnaddress/batch",
+ "httpMethod": "POST",
+ "id": "content.returnaddress.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "returnaddress/batch",
+ "request": {
+ "$ref": "ReturnaddressCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "ReturnaddressCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a return address for the given Merchant Center account.",
+ "flatPath": "{merchantId}/returnaddress/{returnAddressId}",
+ "httpMethod": "DELETE",
+ "id": "content.returnaddress.delete",
+ "parameterOrder": [
+ "merchantId",
+ "returnAddressId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account from which to delete the given return address.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnAddressId": {
+ "description": "Return address ID generated by Google.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnaddress/{returnAddressId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Gets a return address of the Merchant Center account.",
+ "flatPath": "{merchantId}/returnaddress/{returnAddressId}",
+ "httpMethod": "GET",
+ "id": "content.returnaddress.get",
+ "parameterOrder": [
+ "merchantId",
+ "returnAddressId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account to get a return address for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnAddressId": {
+ "description": "Return address ID generated by Google.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnaddress/{returnAddressId}",
+ "response": {
+ "$ref": "ReturnAddress"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a return address for the Merchant Center account.",
+ "flatPath": "{merchantId}/returnaddress",
+ "httpMethod": "POST",
+ "id": "content.returnaddress.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account to insert a return address for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnaddress",
+ "request": {
+ "$ref": "ReturnAddress"
+ },
+ "response": {
+ "$ref": "ReturnAddress"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the return addresses of the Merchant Center account.",
+ "flatPath": "{merchantId}/returnaddress",
+ "httpMethod": "GET",
+ "id": "content.returnaddress.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "country": {
+ "description": "List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of addresses in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The Merchant Center account to list return addresses for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnaddress",
+ "response": {
+ "$ref": "ReturnaddressListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "returnpolicy": {
+ "methods": {
+ "custombatch": {
+ "description": "Batches multiple return policy related calls in a single request.",
+ "flatPath": "returnpolicy/batch",
+ "httpMethod": "POST",
+ "id": "content.returnpolicy.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "returnpolicy/batch",
+ "request": {
+ "$ref": "ReturnpolicyCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "ReturnpolicyCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a return policy for the given Merchant Center account.",
+ "flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
+ "httpMethod": "DELETE",
+ "id": "content.returnpolicy.delete",
+ "parameterOrder": [
+ "merchantId",
+ "returnPolicyId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account from which to delete the given return policy.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPolicyId": {
+ "description": "Return policy ID generated by Google.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicy/{returnPolicyId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Gets a return policy of the Merchant Center account.",
+ "flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
+ "httpMethod": "GET",
+ "id": "content.returnpolicy.get",
+ "parameterOrder": [
+ "merchantId",
+ "returnPolicyId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account to get a return policy for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPolicyId": {
+ "description": "Return policy ID generated by Google.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicy/{returnPolicyId}",
+ "response": {
+ "$ref": "ReturnPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a return policy for the Merchant Center account.",
+ "flatPath": "{merchantId}/returnpolicy",
+ "httpMethod": "POST",
+ "id": "content.returnpolicy.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account to insert a return policy for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicy",
+ "request": {
+ "$ref": "ReturnPolicy"
+ },
+ "response": {
+ "$ref": "ReturnPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the return policies of the Merchant Center account.",
+ "flatPath": "{merchantId}/returnpolicy",
+ "httpMethod": "GET",
+ "id": "content.returnpolicy.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account to list return policies for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicy",
+ "response": {
+ "$ref": "ReturnpolicyListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "returnpolicyonline": {
+ "methods": {
+ "create": {
+ "description": "Creates a new return policy.",
+ "flatPath": "{merchantId}/returnpolicyonline",
+ "httpMethod": "POST",
+ "id": "content.returnpolicyonline.create",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicyonline",
+ "request": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "response": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing return policy.",
+ "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "httpMethod": "DELETE",
+ "id": "content.returnpolicyonline.delete",
+ "parameterOrder": [
+ "merchantId",
+ "returnPolicyId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPolicyId": {
+ "description": "Required. The id of the return policy to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Gets an existing return policy.",
+ "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "httpMethod": "GET",
+ "id": "content.returnpolicyonline.get",
+ "parameterOrder": [
+ "merchantId",
+ "returnPolicyId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPolicyId": {
+ "description": "Required. The id of the return policy to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "response": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists all existing return policies.",
+ "flatPath": "{merchantId}/returnpolicyonline",
+ "httpMethod": "GET",
+ "id": "content.returnpolicyonline.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicyonline",
+ "response": {
+ "$ref": "ListReturnPolicyOnlineResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing return policy.",
+ "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "httpMethod": "PATCH",
+ "id": "content.returnpolicyonline.patch",
+ "parameterOrder": [
+ "merchantId",
+ "returnPolicyId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPolicyId": {
+ "description": "Required. The id of the return policy to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
+ "request": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "response": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "settlementreports": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a settlement report from your Merchant Center account.",
+ "flatPath": "{merchantId}/settlementreports/{settlementId}",
+ "httpMethod": "GET",
+ "id": "content.settlementreports.get",
+ "parameterOrder": [
+ "merchantId",
+ "settlementId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The Merchant Center account of the settlement report.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "settlementId": {
+ "description": "The Google-provided ID of the settlement.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/settlementreports/{settlementId}",
+ "response": {
+ "$ref": "SettlementReport"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of settlement reports from your Merchant Center account.",
+ "flatPath": "{merchantId}/settlementreports",
+ "httpMethod": "GET",
+ "id": "content.settlementreports.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The Merchant Center account to list settlements for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "transferEndDate": {
+ "description": "Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ },
+ "transferStartDate": {
+ "description": "Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/settlementreports",
+ "response": {
+ "$ref": "SettlementreportsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "settlementtransactions": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of transactions for the settlement.",
+ "flatPath": "{merchantId}/settlementreports/{settlementId}/transactions",
+ "httpMethod": "GET",
+ "id": "content.settlementtransactions.list",
+ "parameterOrder": [
+ "merchantId",
+ "settlementId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The Merchant Center account to list transactions for.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "settlementId": {
+ "description": "The Google-provided ID of the settlement.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "transactionIds": {
+ "description": "The list of transactions to return. If not set, all transactions will be returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/settlementreports/{settlementId}/transactions",
+ "response": {
+ "$ref": "SettlementtransactionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "shippingsettings": {
+ "methods": {
+ "custombatch": {
+ "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
+ "flatPath": "shippingsettings/batch",
+ "httpMethod": "POST",
+ "id": "content.shippingsettings.custombatch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "shippingsettings/batch",
+ "request": {
+ "$ref": "ShippingsettingsCustomBatchRequest"
+ },
+ "response": {
+ "$ref": "ShippingsettingsCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the shipping settings of the account.",
+ "flatPath": "{merchantId}/shippingsettings/{accountId}",
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update shipping settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/shippingsettings/{accountId}",
+ "response": {
+ "$ref": "ShippingSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getsupportedcarriers": {
+ "description": "Retrieves supported carriers and carrier services for an account.",
+ "flatPath": "{merchantId}/supportedCarriers",
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.getsupportedcarriers",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account for which to retrieve the supported carriers.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/supportedCarriers",
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedCarriersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getsupportedholidays": {
+ "description": "Retrieves supported holidays for an account.",
+ "flatPath": "{merchantId}/supportedHolidays",
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.getsupportedholidays",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account for which to retrieve the supported holidays.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/supportedHolidays",
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedHolidaysResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getsupportedpickupservices": {
+ "description": "Retrieves supported pickup services for an account.",
+ "flatPath": "{merchantId}/supportedPickupServices",
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.getsupportedpickupservices",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account for which to retrieve the supported pickup services.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/supportedPickupServices",
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
+ "flatPath": "{merchantId}/shippingsettings",
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of shipping settings to return in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/shippingsettings",
+ "response": {
+ "$ref": "ShippingsettingsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "{merchantId}/shippingsettings/{accountId}",
+ "httpMethod": "PUT",
+ "id": "content.shippingsettings.update",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update shipping settings.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/shippingsettings/{accountId}",
+ "request": {
+ "$ref": "ShippingSettings"
+ },
+ "response": {
+ "$ref": "ShippingSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210519",
+ "rootUrl": "https://shoppingcontent.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.",
+ "id": "Account",
+ "properties": {
+ "adsLinks": {
+ "description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.",
+ "items": {
+ "$ref": "AccountAdsLink"
+ },
+ "type": "array"
+ },
+ "adultContent": {
+ "description": "Indicates whether the merchant sells adult content.",
+ "type": "boolean"
+ },
+ "automaticLabelIds": {
+ "description": "Automatically created label IDs that are assigned to the account by CSS Center.",
+ "items": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "businessInformation": {
+ "$ref": "AccountBusinessInformation",
+ "description": "The business information of the account."
+ },
+ "cssId": {
+ "description": "ID of CSS the account belongs to.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "googleMyBusinessLink": {
+ "$ref": "AccountGoogleMyBusinessLink",
+ "description": "The GMB account which is linked or in the process of being linked with the Merchant Center account."
+ },
+ "id": {
+ "description": "Required for update. Merchant Center account ID.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\"",
+ "type": "string"
+ },
+ "labelIds": {
+ "description": "Manually created label IDs that are assigned to the account by CSS.",
+ "items": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Required. Display name for the account.",
+ "type": "string"
+ },
+ "sellerId": {
+ "description": "Client-specific, locally-unique, internal ID for the child account.",
+ "type": "string"
+ },
+ "users": {
+ "description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
+ "items": {
+ "$ref": "AccountUser"
+ },
+ "type": "array"
+ },
+ "websiteUrl": {
+ "description": "The merchant's website.",
+ "type": "string"
+ },
+ "youtubeChannelLinks": {
+ "description": "Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
+ "items": {
+ "$ref": "AccountYouTubeChannelLink"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountAddress": {
+ "id": "AccountAddress",
+ "properties": {
+ "country": {
+ "description": "CLDR country code (e.g. \"US\"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code or ZIP (e.g. \"94043\").",
+ "type": "string"
+ },
+ "region": {
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
+ "type": "string"
+ },
+ "streetAddress": {
+ "description": "Street-level part of the address.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountAdsLink": {
+ "id": "AccountAdsLink",
+ "properties": {
+ "adsId": {
+ "description": "Customer ID of the Ads account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountBusinessInformation": {
+ "id": "AccountBusinessInformation",
+ "properties": {
+ "address": {
+ "$ref": "AccountAddress",
+ "description": "The address of the business."
+ },
+ "customerService": {
+ "$ref": "AccountCustomerService",
+ "description": "The customer service information of the business."
+ },
+ "phoneNumber": {
+ "description": "The phone number of the business.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountCredentials": {
+ "description": "Credentials allowing Google to call a partner's API on behalf of a merchant.",
+ "id": "AccountCredentials",
+ "properties": {
+ "accessToken": {
+ "description": "An OAuth access token.",
+ "type": "string"
+ },
+ "expiresIn": {
+ "description": "The amount of time, in seconds, after which the access token is no longer valid.",
+ "format": "int64",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "Indicates to Google how Google should use these OAuth tokens.",
+ "enum": [
+ "ACCOUNT_CREDENTIALS_PURPOSE_UNSPECIFIED",
+ "SHOPIFY_ORDER_MANAGEMENT"
+ ],
+ "enumDescriptions": [
+ "Unknown purpose.",
+ "The credentials allow Google to manage Shopify orders on behalf of the merchant."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountCustomerService": {
+ "id": "AccountCustomerService",
+ "properties": {
+ "email": {
+ "description": "Customer service email.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Customer service phone number.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Customer service URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountGoogleMyBusinessLink": {
+ "id": "AccountGoogleMyBusinessLink",
+ "properties": {
+ "gmbAccountId": {
+ "description": "The ID of the GMB account. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the GMB API.",
+ "type": "string"
+ },
+ "gmbEmail": {
+ "description": "The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountIdentifier": {
+ "id": "AccountIdentifier",
+ "properties": {
+ "aggregatorId": {
+ "description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
+ "format": "uint64",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The merchant account ID, set for individual accounts and subaccounts.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountLabel": {
+ "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
+ "id": "AccountLabel",
+ "properties": {
+ "accountId": {
+ "description": "Immutable. The ID of account this label belongs to.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of this label.",
+ "type": "string"
+ },
+ "labelId": {
+ "description": "Output only. The ID of the label.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "labelType": {
+ "description": "Output only. The type of this label.",
+ "enum": [
+ "LABEL_TYPE_UNSPECIFIED",
+ "MANUAL",
+ "AUTOMATIC"
+ ],
+ "enumDescriptions": [
+ "Unknown label type.",
+ "Indicates that the label was created manually.",
+ "Indicates that the label was created automatically by CSS Center."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name of this label.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountReturnCarrier": {
+ "description": " The return carrier information. This service is designed for merchants enrolled in the Buy on Google program. ",
+ "id": "AccountReturnCarrier",
+ "properties": {
+ "carrierAccountId": {
+ "description": "Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "carrierAccountName": {
+ "description": "Name of the carrier account.",
+ "type": "string"
+ },
+ "carrierAccountNumber": {
+ "description": "Number of the carrier account.",
+ "type": "string"
+ },
+ "carrierCode": {
+ "description": "The carrier code enum. Accepts the values FEDEX or UPS.",
+ "enum": [
+ "CARRIER_CODE_UNSPECIFIED",
+ "FEDEX",
+ "UPS"
+ ],
+ "enumDescriptions": [
+ "Carrier not specified",
+ "FedEx carrier",
+ "UPS carrier"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatus": {
+ "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
+ "id": "AccountStatus",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account for which the status is reported.",
+ "type": "string"
+ },
+ "accountLevelIssues": {
+ "description": "A list of account level issues.",
+ "items": {
+ "$ref": "AccountStatusAccountLevelIssue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"",
+ "type": "string"
},
- "AccountGoogleMyBusinessLink": {
- "id": "AccountGoogleMyBusinessLink",
- "properties": {
- "gmbAccountId": {
- "description": "The ID of the GMB account. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the GMB API.",
- "type": "string"
- },
- "gmbEmail": {
- "description": "The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.",
- "type": "string"
- },
- "status": {
- "description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "products": {
+ "description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.",
+ "items": {
+ "$ref": "AccountStatusProducts"
+ },
+ "type": "array"
+ },
+ "websiteClaimed": {
+ "description": "Whether the account's website is claimed or not.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatusAccountLevelIssue": {
+ "id": "AccountStatusAccountLevelIssue",
+ "properties": {
+ "country": {
+ "description": "Country for which this issue is reported.",
+ "type": "string"
+ },
+ "destination": {
+ "description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Additional details about the issue.",
+ "type": "string"
+ },
+ "documentation": {
+ "description": "The URL of a web page to help resolving this issue.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Issue identifier.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ",
+ "type": "string"
+ },
+ "title": {
+ "description": "Short description of the issue.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatusItemLevelIssue": {
+ "id": "AccountStatusItemLevelIssue",
+ "properties": {
+ "attributeName": {
+ "description": "The attribute's name, if the issue is caused by a single attribute.",
+ "type": "string"
+ },
+ "code": {
+ "description": "The error code of the issue.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A short issue description in English.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "A detailed issue description in English.",
+ "type": "string"
+ },
+ "documentation": {
+ "description": "The URL of a web page to help with resolving this issue.",
+ "type": "string"
+ },
+ "numItems": {
+ "description": "Number of items with this issue.",
+ "format": "int64",
+ "type": "string"
+ },
+ "resolution": {
+ "description": "Whether the issue can be resolved by the merchant.",
+ "type": "string"
+ },
+ "servability": {
+ "description": "How this issue affects serving of the offer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatusProducts": {
+ "id": "AccountStatusProducts",
+ "properties": {
+ "channel": {
+ "description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" ",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country the data applies to.",
+ "type": "string"
+ },
+ "destination": {
+ "description": "The destination the data applies to.",
+ "type": "string"
+ },
+ "itemLevelIssues": {
+ "description": "List of item-level issues.",
+ "items": {
+ "$ref": "AccountStatusItemLevelIssue"
+ },
+ "type": "array"
+ },
+ "statistics": {
+ "$ref": "AccountStatusStatistics",
+ "description": "Aggregated product statistics."
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatusStatistics": {
+ "id": "AccountStatusStatistics",
+ "properties": {
+ "active": {
+ "description": "Number of active offers.",
+ "format": "int64",
+ "type": "string"
+ },
+ "disapproved": {
+ "description": "Number of disapproved offers.",
+ "format": "int64",
+ "type": "string"
+ },
+ "expiring": {
+ "description": "Number of expiring offers.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pending": {
+ "description": "Number of pending offers.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountTax": {
+ "description": "The tax settings of a merchant account. All methods require the admin role.",
+ "id": "AccountTax",
+ "properties": {
+ "accountId": {
+ "description": "Required. The ID of the account to which these account tax settings belong.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\".",
+ "type": "string"
+ },
+ "rules": {
+ "description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
+ "items": {
+ "$ref": "AccountTaxTaxRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountTaxTaxRule": {
+ "description": "Tax calculation rule to apply in a state or province (USA only).",
+ "id": "AccountTaxTaxRule",
+ "properties": {
+ "country": {
+ "description": "Country code in which tax is applicable.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).",
+ "format": "uint64",
+ "type": "string"
+ },
+ "ratePercent": {
+ "description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.",
+ "type": "string"
+ },
+ "shippingTaxed": {
+ "description": "If true, shipping charges are also taxed.",
+ "type": "boolean"
+ },
+ "useGlobalRate": {
+ "description": "Whether the tax rate is taken from a global tax table or specified explicitly.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUser": {
+ "id": "AccountUser",
+ "properties": {
+ "admin": {
+ "description": "Whether user is an admin.",
+ "type": "boolean"
+ },
+ "emailAddress": {
+ "description": "User's email address.",
+ "type": "string"
+ },
+ "orderManager": {
+ "description": "Whether user is an order manager.",
+ "type": "boolean"
+ },
+ "paymentsAnalyst": {
+ "description": "Whether user can access payment statements.",
+ "type": "boolean"
+ },
+ "paymentsManager": {
+ "description": "Whether user can manage payment settings.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AccountYouTubeChannelLink": {
+ "id": "AccountYouTubeChannelLink",
+ "properties": {
+ "channelId": {
+ "description": "Channel ID.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsAuthInfoResponse": {
+ "id": "AccountsAuthInfoResponse",
+ "properties": {
+ "accountIdentifiers": {
+ "description": "The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. ",
+ "items": {
+ "$ref": "AccountIdentifier"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsClaimWebsiteResponse": {
+ "id": "AccountsClaimWebsiteResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsCustomBatchRequest": {
+ "id": "AccountsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "AccountsCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch accounts request.",
+ "id": "AccountsCustomBatchRequestEntry",
+ "properties": {
+ "account": {
+ "$ref": "Account",
+ "description": "The account to create or update. Only defined if the method is `insert` or `update`."
+ },
+ "accountId": {
+ "description": "The ID of the targeted account. Only defined if the method is not `insert`.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "force": {
+ "description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.",
+ "type": "boolean"
+ },
+ "labelIds": {
+ "description": "Label IDs for the 'updatelabels' request.",
+ "items": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountIdentifier": {
- "id": "AccountIdentifier",
- "properties": {
- "aggregatorId": {
- "description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The merchant account ID, set for individual accounts and subaccounts.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
+ "linkRequest": {
+ "$ref": "AccountsCustomBatchRequestEntryLinkRequest",
+ "description": "Details about the `link` request."
},
- "AccountLabel": {
- "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
- "id": "AccountLabel",
- "properties": {
- "accountId": {
- "description": "Immutable. The ID of account this label belongs to.",
- "format": "int64",
- "type": "string"
- },
- "description": {
- "description": "The description of this label.",
- "type": "string"
- },
- "labelId": {
- "description": "Output only. The ID of the label.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "labelType": {
- "description": "Output only. The type of this label.",
- "enum": [
- "LABEL_TYPE_UNSPECIFIED",
- "MANUAL",
- "AUTOMATIC"
- ],
- "enumDescriptions": [
- "Unknown label type.",
- "Indicates that the label was created manually.",
- "Indicates that the label was created automatically by CSS Center."
- ],
- "readOnly": true,
- "type": "string"
- },
- "name": {
- "description": "The display name of this label.",
- "type": "string"
- }
- },
- "type": "object"
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
},
- "AccountReturnCarrier": {
- "description": " The return carrier information. This service is designed for merchants enrolled in the Buy on Google program. ",
- "id": "AccountReturnCarrier",
- "properties": {
- "carrierAccountId": {
- "description": "Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "carrierAccountName": {
- "description": "Name of the carrier account.",
- "type": "string"
- },
- "carrierAccountNumber": {
- "description": "Number of the carrier account.",
- "type": "string"
- },
- "carrierCode": {
- "description": "The carrier code enum. Accepts the values FEDEX or UPS.",
- "enum": [
- "CARRIER_CODE_UNSPECIFIED",
- "FEDEX",
- "UPS"
- ],
- "enumDescriptions": [
- "Carrier not specified",
- "FedEx carrier",
- "UPS carrier"
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" ",
+ "type": "string"
},
- "AccountStatus": {
- "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
- "id": "AccountStatus",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which the status is reported.",
- "type": "string"
- },
- "accountLevelIssues": {
- "description": "A list of account level issues.",
- "items": {
- "$ref": "AccountStatusAccountLevelIssue"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"",
- "type": "string"
- },
- "products": {
- "description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.",
- "items": {
- "$ref": "AccountStatusProducts"
- },
- "type": "array"
- },
- "websiteClaimed": {
- "description": "Whether the account's website is claimed or not.",
- "type": "boolean"
- }
- },
- "type": "object"
+ "overwrite": {
+ "description": "Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.",
+ "type": "boolean"
},
- "AccountStatusAccountLevelIssue": {
- "id": "AccountStatusAccountLevelIssue",
- "properties": {
- "country": {
- "description": "Country for which this issue is reported.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations.",
- "type": "string"
- },
- "detail": {
- "description": "Additional details about the issue.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help resolving this issue.",
- "type": "string"
- },
- "id": {
- "description": "Issue identifier.",
- "type": "string"
- },
- "severity": {
- "description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ",
- "type": "string"
- },
- "title": {
- "description": "Short description of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountStatusItemLevelIssue": {
- "id": "AccountStatusItemLevelIssue",
- "properties": {
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "numItems": {
- "description": "Number of items with this issue.",
- "format": "int64",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects serving of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountStatusProducts": {
- "id": "AccountStatusProducts",
- "properties": {
- "channel": {
- "description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" ",
- "type": "string"
- },
- "country": {
- "description": "The country the data applies to.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the data applies to.",
- "type": "string"
- },
- "itemLevelIssues": {
- "description": "List of item-level issues.",
- "items": {
- "$ref": "AccountStatusItemLevelIssue"
- },
- "type": "array"
- },
- "statistics": {
- "$ref": "AccountStatusStatistics",
- "description": "Aggregated product statistics."
- }
- },
- "type": "object"
- },
- "AccountStatusStatistics": {
- "id": "AccountStatusStatistics",
- "properties": {
- "active": {
- "description": "Number of active offers.",
- "format": "int64",
- "type": "string"
- },
- "disapproved": {
- "description": "Number of disapproved offers.",
- "format": "int64",
- "type": "string"
- },
- "expiring": {
- "description": "Number of expiring offers.",
- "format": "int64",
- "type": "string"
- },
- "pending": {
- "description": "Number of pending offers.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountTax": {
- "description": "The tax settings of a merchant account. All methods require the admin role.",
- "id": "AccountTax",
- "properties": {
- "accountId": {
- "description": "Required. The ID of the account to which these account tax settings belong.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\".",
- "type": "string"
- },
- "rules": {
- "description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
- "items": {
- "$ref": "AccountTaxTaxRule"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountTaxTaxRule": {
- "description": "Tax calculation rule to apply in a state or province (USA only).",
- "id": "AccountTaxTaxRule",
- "properties": {
- "country": {
- "description": "Country code in which tax is applicable.",
- "type": "string"
- },
- "locationId": {
- "description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).",
- "format": "uint64",
- "type": "string"
- },
- "ratePercent": {
- "description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.",
- "type": "string"
- },
- "shippingTaxed": {
- "description": "If true, shipping charges are also taxed.",
- "type": "boolean"
- },
- "useGlobalRate": {
- "description": "Whether the tax rate is taken from a global tax table or specified explicitly.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountUser": {
- "id": "AccountUser",
- "properties": {
- "admin": {
- "description": "Whether user is an admin.",
- "type": "boolean"
- },
- "emailAddress": {
- "description": "User's email address.",
- "type": "string"
- },
- "orderManager": {
- "description": "Whether user is an order manager.",
- "type": "boolean"
- },
- "paymentsAnalyst": {
- "description": "Whether user can access payment statements.",
- "type": "boolean"
- },
- "paymentsManager": {
- "description": "Whether user can manage payment settings.",
- "type": "boolean"
- }
- },
- "type": "object"
+ "view": {
+ "description": "Controls which fields are visible. Only applicable if the method is 'get'.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsCustomBatchRequestEntryLinkRequest": {
+ "id": "AccountsCustomBatchRequestEntryLinkRequest",
+ "properties": {
+ "action": {
+ "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
+ "type": "string"
+ },
+ "linkType": {
+ "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
+ "type": "string"
+ },
+ "linkedAccountId": {
+ "description": "The ID of the linked account.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Provided services. Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsCustomBatchResponse": {
+ "id": "AccountsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "AccountsCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch accounts response.",
+ "id": "AccountsCustomBatchResponseEntry",
+ "properties": {
+ "account": {
+ "$ref": "Account",
+ "description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`."
+ },
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsLinkRequest": {
+ "id": "AccountsLinkRequest",
+ "properties": {
+ "action": {
+ "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
+ "type": "string"
+ },
+ "linkType": {
+ "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" - \"`paymentServiceProvider`\" ",
+ "type": "string"
+ },
+ "linkedAccountId": {
+ "description": "The ID of the linked account.",
+ "type": "string"
+ },
+ "paymentServiceProviderLinkInfo": {
+ "$ref": "PaymentServiceProviderLinkInfo",
+ "description": "Additional information required for `paymentServiceProvider` link type."
+ },
+ "services": {
+ "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`paymentProcessing`\" ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsLinkResponse": {
+ "id": "AccountsLinkResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsListLinksResponse": {
+ "id": "AccountsListLinksResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListLinksResponse\".",
+ "type": "string"
+ },
+ "links": {
+ "description": "The list of available links.",
+ "items": {
+ "$ref": "LinkedAccount"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of links.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsListResponse": {
+ "id": "AccountsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of accounts.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsUpdateLabelsRequest": {
+ "id": "AccountsUpdateLabelsRequest",
+ "properties": {
+ "labelIds": {
+ "description": "The IDs of labels that should be assigned to the account.",
+ "items": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsUpdateLabelsResponse": {
+ "id": "AccountsUpdateLabelsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsUpdateLabelsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountstatusesCustomBatchRequest": {
+ "id": "AccountstatusesCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "AccountstatusesCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountstatusesCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch accountstatuses request.",
+ "id": "AccountstatusesCustomBatchRequestEntry",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the (sub-)account whose status to get.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountYouTubeChannelLink": {
- "id": "AccountYouTubeChannelLink",
- "properties": {
- "channelId": {
- "description": "Channel ID.",
- "type": "string"
- },
- "status": {
- "description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsAuthInfoResponse": {
- "id": "AccountsAuthInfoResponse",
- "properties": {
- "accountIdentifiers": {
- "description": "The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. ",
- "items": {
- "$ref": "AccountIdentifier"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
},
- "AccountsClaimWebsiteResponse": {
- "id": "AccountsClaimWebsiteResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchRequest": {
- "id": "AccountsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountstatusesCustomBatchResponse": {
+ "id": "AccountstatusesCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "AccountstatusesCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountstatusesCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch accountstatuses response.",
+ "id": "AccountstatusesCustomBatchResponseEntry",
+ "properties": {
+ "accountStatus": {
+ "$ref": "AccountStatus",
+ "description": "The requested account status. Defined if and only if the request was successful."
+ },
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ }
+ },
+ "type": "object"
+ },
+ "AccountstatusesListResponse": {
+ "id": "AccountstatusesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of account statuses.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "AccountStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccounttaxCustomBatchRequest": {
+ "id": "AccounttaxCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "AccounttaxCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccounttaxCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch accounttax request.",
+ "id": "AccounttaxCustomBatchRequestEntry",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "accountTax": {
+ "$ref": "AccountTax",
+ "description": "The account tax settings to update. Only defined if the method is `update`."
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccounttaxCustomBatchResponse": {
+ "id": "AccounttaxCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "AccounttaxCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccounttaxCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch accounttax response.",
+ "id": "AccounttaxCustomBatchResponseEntry",
+ "properties": {
+ "accountTax": {
+ "$ref": "AccountTax",
+ "description": "The retrieved or updated account tax settings."
+ },
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccounttaxListResponse": {
+ "id": "AccounttaxListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of account tax settings.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "AccountTax"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ActivateBuyOnGoogleProgramRequest": {
+ "description": "Request message for the ActivateProgram method.",
+ "id": "ActivateBuyOnGoogleProgramRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "Amount": {
+ "id": "Amount",
+ "properties": {
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "[required] The pre-tax or post-tax price depending on the location of the order."
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "[required] Tax value."
+ }
+ },
+ "type": "object"
+ },
+ "BusinessDayConfig": {
+ "id": "BusinessDayConfig",
+ "properties": {
+ "businessDays": {
+ "description": "Regular business days. May not be empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BuyOnGoogleProgramStatus": {
+ "description": "Response message for the GetProgramStatus method.",
+ "id": "BuyOnGoogleProgramStatus",
+ "properties": {
+ "customerServicePendingEmail": {
+ "description": "The customer service pending email.",
+ "type": "string"
+ },
+ "customerServiceVerifiedEmail": {
+ "description": "The customer service verified email.",
+ "type": "string"
+ },
+ "participationStage": {
+ "description": "The current participation stage for the program.",
+ "enum": [
+ "PROGRAM_PARTICIPATION_STAGE_UNSPECIFIED",
+ "NOT_ELIGIBLE",
+ "ELIGIBLE",
+ "ONBOARDING",
+ "ELIGIBLE_FOR_REVIEW",
+ "PENDING_REVIEW",
+ "REVIEW_DISAPPROVED",
+ "ACTIVE",
+ "PAUSED"
+ ],
+ "enumDescriptions": [
+ "Default value when participation stage is not set.",
+ "Merchant is not eligible for onboarding to a given program in a specific region code.",
+ "Merchant is eligible for onboarding to a given program in a specific region code.",
+ "Merchant is onboarding to a given program in a specific region code.",
+ "Merchant fulfilled all the requirements and is ready to request review in a specific region code.",
+ "Merchant is waiting for the review to be completed in a specific region code.",
+ "The review for a merchant has been rejected in a specific region code.",
+ "Merchant's program participation is active for a specific region code.",
+ "Participation has been paused."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CarrierRate": {
+ "id": "CarrierRate",
+ "properties": {
+ "carrierName": {
+ "description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.",
+ "type": "string"
+ },
+ "carrierService": {
+ "description": "Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.",
+ "type": "string"
+ },
+ "flatAdjustment": {
+ "$ref": "Price",
+ "description": "Additive shipping rate modifier. Can be negative. For example `{ \"value\": \"1\", \"currency\" : \"USD\" }` adds $1 to the rate, `{ \"value\": \"-3\", \"currency\" : \"USD\" }` removes $3 from the rate. Optional."
+ },
+ "name": {
+ "description": "Name of the carrier rate. Must be unique per rate group. Required.",
+ "type": "string"
+ },
+ "originPostalCode": {
+ "description": "Shipping origin for this carrier rate. Required.",
+ "type": "string"
+ },
+ "percentageAdjustment": {
+ "description": "Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `\"5.4\"` increases the rate by 5.4%, `\"-3\"` decreases the rate by 3%. Optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CarriersCarrier": {
+ "id": "CarriersCarrier",
+ "properties": {
+ "country": {
+ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
+ "type": "string"
+ },
+ "eddServices": {
+ "description": "A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accounts request.",
- "id": "AccountsCustomBatchRequestEntry",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The account to create or update. Only defined if the method is `insert` or `update`."
- },
- "accountId": {
- "description": "The ID of the targeted account. Only defined if the method is not `insert`.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "force": {
- "description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.",
- "type": "boolean"
- },
- "labelIds": {
- "description": "Label IDs for the 'updatelabels' request.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "linkRequest": {
- "$ref": "AccountsCustomBatchRequestEntryLinkRequest",
- "description": "Details about the `link` request."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" ",
- "type": "string"
- },
- "overwrite": {
- "description": "Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.",
- "type": "boolean"
- },
- "view": {
- "description": "Controls which fields are visible. Only applicable if the method is 'get'.",
- "type": "string"
- }
- },
- "type": "object"
+ "name": {
+ "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
+ "type": "string"
},
- "AccountsCustomBatchRequestEntryLinkRequest": {
- "id": "AccountsCustomBatchRequestEntryLinkRequest",
- "properties": {
- "action": {
- "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
- "type": "string"
- },
- "linkType": {
- "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
- "type": "string"
- },
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "services": {
- "description": "Provided services. Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchResponse": {
- "id": "AccountsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "services": {
+ "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Collection": {
+ "description": "The collection message.",
+ "id": "Collection",
+ "properties": {
+ "customLabel0": {
+ "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)",
+ "type": "string"
+ },
+ "customLabel1": {
+ "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
+ "type": "string"
+ },
+ "customLabel2": {
+ "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
+ "type": "string"
+ },
+ "customLabel3": {
+ "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
+ "type": "string"
+ },
+ "customLabel4": {
+ "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
+ "type": "string"
+ },
+ "featuredProduct": {
+ "description": "This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)",
+ "items": {
+ "$ref": "CollectionFeaturedProduct"
+ },
+ "type": "array"
+ },
+ "headline": {
+ "description": "Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accounts response.",
- "id": "AccountsCustomBatchResponseEntry",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
+ "id": {
+ "description": "Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)",
+ "type": "string"
},
- "AccountsLinkRequest": {
- "id": "AccountsLinkRequest",
- "properties": {
- "action": {
- "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
- "type": "string"
- },
- "linkType": {
- "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
- "type": "string"
- },
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "services": {
- "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingAdsOther`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsOther`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "imageLink": {
+ "description": "The URL of a collection\u2019s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountsLinkResponse": {
- "id": "AccountsLinkResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "language": {
+ "description": "The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)",
+ "type": "string"
},
- "AccountsListLinksResponse": {
- "id": "AccountsListLinksResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListLinksResponse\".",
- "type": "string"
- },
- "links": {
- "description": "The list of available links.",
- "items": {
- "$ref": "LinkedAccount"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of links.",
- "type": "string"
- }
- },
- "type": "object"
+ "link": {
+ "description": "A collection\u2019s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)",
+ "type": "string"
},
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of accounts.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Account"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsUpdateLabelsRequest": {
- "id": "AccountsUpdateLabelsRequest",
- "properties": {
- "labelIds": {
- "description": "The IDs of labels that should be assigned to the account.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "mobileLink": {
+ "description": "A collection\u2019s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)",
+ "type": "string"
},
- "AccountsUpdateLabelsResponse": {
- "id": "AccountsUpdateLabelsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsUpdateLabelsResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchRequest": {
- "id": "AccountstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "productCountry": {
+ "description": "[product_country attribute](https://support.google.com/merchants/answer/9674155)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CollectionFeaturedProduct": {
+ "description": "The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)",
+ "id": "CollectionFeaturedProduct",
+ "properties": {
+ "offerId": {
+ "description": "The unique identifier for the product item.",
+ "type": "string"
+ },
+ "x": {
+ "description": "Required. X-coordinate of the product callout on the Shoppable Image.",
+ "format": "float",
+ "type": "number"
+ },
+ "y": {
+ "description": "Required. Y-coordinate of the product callout on the Shoppable Image.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "CollectionStatus": {
+ "description": "The collectionstatus message.",
+ "id": "CollectionStatus",
+ "properties": {
+ "collectionLevelIssuses": {
+ "description": "A list of all issues associated with the collection.",
+ "items": {
+ "$ref": "CollectionStatusItemLevelIssue"
+ },
+ "type": "array"
+ },
+ "creationDate": {
+ "description": "Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
+ "type": "string"
+ },
+ "destinationStatuses": {
+ "description": "The intended destinations for the collection.",
+ "items": {
+ "$ref": "CollectionStatusDestinationStatus"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Required. The ID of the collection for which status is reported.",
+ "type": "string"
+ },
+ "lastUpdateDate": {
+ "description": "Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CollectionStatusDestinationStatus": {
+ "description": "Destination status message.",
+ "id": "CollectionStatusDestinationStatus",
+ "properties": {
+ "destination": {
+ "description": "The name of the destination",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status for the specified destination.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CollectionStatusItemLevelIssue": {
+ "description": "Issue associated with the collection.",
+ "id": "CollectionStatusItemLevelIssue",
+ "properties": {
+ "attributeName": {
+ "description": "The attribute's name, if the issue is caused by a single attribute.",
+ "type": "string"
+ },
+ "code": {
+ "description": "The error code of the issue.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A short issue description in English.",
+ "type": "string"
+ },
+ "destination": {
+ "description": "The destination the issue applies to.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "A detailed issue description in English.",
+ "type": "string"
+ },
+ "documentation": {
+ "description": "The URL of a web page to help with resolving this issue.",
+ "type": "string"
+ },
+ "resolution": {
+ "description": "Whether the issue can be resolved by the merchant.",
+ "type": "string"
+ },
+ "servability": {
+ "description": "How this issue affects the serving of the collection.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Css": {
+ "description": "Information about CSS domain.",
+ "id": "Css",
+ "properties": {
+ "cssDomainId": {
+ "description": "Output only. Immutable. The CSS domain ID.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "cssGroupId": {
+ "description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Output only. Immutable. The CSS domain's display name, used when space is constrained.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "fullName": {
+ "description": "Output only. Immutable. The CSS domain's full name.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "homepageUri": {
+ "description": "Output only. Immutable. The CSS domain's homepage.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "labelIds": {
+ "description": "A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomAttribute": {
+ "id": "CustomAttribute",
+ "properties": {
+ "groupValues": {
+ "description": "Subattributes within this attribute group. Exactly one of value or groupValues must be provided.",
+ "items": {
+ "$ref": "CustomAttribute"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the attribute. Underscores will be replaced by spaces upon insertion.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the attribute.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomerReturnReason": {
+ "id": "CustomerReturnReason",
+ "properties": {
+ "description": {
+ "description": "Description of the reason.",
+ "type": "string"
+ },
+ "reasonCode": {
+ "description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CutoffTime": {
+ "id": "CutoffTime",
+ "properties": {
+ "hour": {
+ "description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "minute": {
+ "description": "Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timezone": {
+ "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Datafeed": {
+ "description": "Datafeed configuration data.",
+ "id": "Datafeed",
+ "properties": {
+ "attributeLanguage": {
+ "description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
+ "type": "string"
+ },
+ "contentType": {
+ "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" ",
+ "type": "string"
+ },
+ "fetchSchedule": {
+ "$ref": "DatafeedFetchSchedule",
+ "description": "Fetch schedule for the feed file."
+ },
+ "fileName": {
+ "description": "Required. The filename of the feed. All feeds must have a unique file name.",
+ "type": "string"
+ },
+ "format": {
+ "$ref": "DatafeedFormat",
+ "description": "Format of the feed file."
+ },
+ "id": {
+ "description": "Required for update. The ID of the data feed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\"",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required for insert. A descriptive name of the data feed.",
+ "type": "string"
+ },
+ "targets": {
+ "description": "The targets this feed should apply to (country, language, destinations).",
+ "items": {
+ "$ref": "DatafeedTarget"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedFetchSchedule": {
+ "description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.",
+ "id": "DatafeedFetchSchedule",
+ "properties": {
+ "dayOfMonth": {
+ "description": "The day of the month the feed file should be fetched (1-31).",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "fetchUrl": {
+ "description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
+ "type": "string"
+ },
+ "hour": {
+ "description": "The hour of the day the feed file should be fetched (0-23).",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "minuteOfHour": {
+ "description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "password": {
+ "description": "An optional password for fetch_url.",
+ "type": "string"
+ },
+ "paused": {
+ "description": "Whether the scheduled fetch is paused or not.",
+ "type": "boolean"
+ },
+ "timeZone": {
+ "description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".",
+ "type": "string"
+ },
+ "username": {
+ "description": "An optional user name for fetch_url.",
+ "type": "string"
+ },
+ "weekday": {
+ "description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedFormat": {
+ "id": "DatafeedFormat",
+ "properties": {
+ "columnDelimiter": {
+ "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" ",
+ "type": "string"
+ },
+ "fileEncoding": {
+ "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ",
+ "type": "string"
+ },
+ "quotingMode": {
+ "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedStatus": {
+ "description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
+ "id": "DatafeedStatus",
+ "properties": {
+ "country": {
+ "description": "The country for which the status is reported, represented as a CLDR territory code.",
+ "type": "string"
+ },
+ "datafeedId": {
+ "description": "The ID of the feed for which the status is reported.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "errors": {
+ "description": "The list of errors occurring in the feed.",
+ "items": {
+ "$ref": "DatafeedStatusError"
+ },
+ "type": "array"
+ },
+ "itemsTotal": {
+ "description": "The number of items in the feed that were processed.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "itemsValid": {
+ "description": "The number of items in the feed that were valid.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"",
+ "type": "string"
+ },
+ "language": {
+ "description": "The two-letter ISO 639-1 language for which the status is reported.",
+ "type": "string"
+ },
+ "lastUploadDate": {
+ "description": "The last date at which the feed was uploaded.",
+ "type": "string"
+ },
+ "processingStatus": {
+ "description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. ",
+ "type": "string"
+ },
+ "warnings": {
+ "description": "The list of errors occurring in the feed.",
+ "items": {
+ "$ref": "DatafeedStatusError"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedStatusError": {
+ "description": "An error occurring in the feed, like \"invalid price\".",
+ "id": "DatafeedStatusError",
+ "properties": {
+ "code": {
+ "description": "The code of the error, e.g., \"validation/invalid_value\".",
+ "type": "string"
+ },
+ "count": {
+ "description": "The number of occurrences of the error in the feed.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "examples": {
+ "description": "A list of example occurrences of the error, grouped by product.",
+ "items": {
+ "$ref": "DatafeedStatusExample"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "The error message, e.g., \"Invalid price\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedStatusExample": {
+ "description": "An example occurrence for a particular error.",
+ "id": "DatafeedStatusExample",
+ "properties": {
+ "itemId": {
+ "description": "The ID of the example item.",
+ "type": "string"
+ },
+ "lineNumber": {
+ "description": "Line number in the data feed where the example is found.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "value": {
+ "description": "The problematic value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedTarget": {
+ "id": "DatafeedTarget",
+ "properties": {
+ "country": {
+ "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code.",
+ "type": "string"
+ },
+ "excludedDestinations": {
+ "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accountstatuses request.",
- "id": "AccountstatusesCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the (sub-)account whose status to get.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchResponse": {
- "id": "AccountstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "includedDestinations": {
+ "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accountstatuses response.",
- "id": "AccountstatusesCustomBatchResponseEntry",
- "properties": {
- "accountStatus": {
- "$ref": "AccountStatus",
- "description": "The requested account status. Defined if and only if the request was successful."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- },
- "type": "object"
+ "language": {
+ "description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsCustomBatchRequest": {
+ "id": "DatafeedsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "DatafeedsCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch datafeeds request.",
+ "id": "DatafeedsCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "datafeed": {
+ "$ref": "Datafeed",
+ "description": "The data feed to insert."
+ },
+ "datafeedId": {
+ "description": "The ID of the data feed to get, delete or fetch.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsCustomBatchResponse": {
+ "id": "DatafeedsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "DatafeedsCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch datafeeds response.",
+ "id": "DatafeedsCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "datafeed": {
+ "$ref": "Datafeed",
+ "description": "The requested data feed. Defined if and only if the request was successful."
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsFetchNowResponse": {
+ "id": "DatafeedsFetchNowResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedsListResponse": {
+ "id": "DatafeedsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of datafeeds.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "Datafeed"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedstatusesCustomBatchRequest": {
+ "id": "DatafeedstatusesCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "DatafeedstatusesCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedstatusesCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch datafeedstatuses request.",
+ "id": "DatafeedstatusesCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "country": {
+ "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required.",
+ "type": "string"
+ },
+ "datafeedId": {
+ "description": "The ID of the data feed to get.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedstatusesCustomBatchResponse": {
+ "id": "DatafeedstatusesCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "DatafeedstatusesCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedstatusesCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch datafeedstatuses response.",
+ "id": "DatafeedstatusesCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "datafeedStatus": {
+ "$ref": "DatafeedStatus",
+ "description": "The requested data feed status. Defined if and only if the request was successful."
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedstatusesListResponse": {
+ "id": "DatafeedstatusesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of datafeed statuses.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "DatafeedStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Date": {
+ "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
+ "id": "Date",
+ "properties": {
+ "day": {
+ "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "year": {
+ "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DateTime": {
+ "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
+ "id": "DateTime",
+ "properties": {
+ "day": {
+ "description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hours": {
+ "description": "Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minutes": {
+ "description": "Required. Minutes of hour of day. Must be from 0 to 59.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Required. Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nanos": {
+ "description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "description": "Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "timeZone": {
+ "$ref": "TimeZone",
+ "description": "Time zone."
+ },
+ "utcOffset": {
+ "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "year": {
+ "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DeliveryTime": {
+ "id": "DeliveryTime",
+ "properties": {
+ "cutoffTime": {
+ "$ref": "CutoffTime",
+ "description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
+ },
+ "handlingBusinessDayConfig": {
+ "$ref": "BusinessDayConfig",
+ "description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
+ },
+ "holidayCutoffs": {
+ "description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
+ "items": {
+ "$ref": "HolidayCutoff"
+ },
+ "type": "array"
+ },
+ "maxHandlingTimeInDays": {
+ "description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "maxTransitTimeInDays": {
+ "description": "Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "minHandlingTimeInDays": {
+ "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "minTransitTimeInDays": {
+ "description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "transitBusinessDayConfig": {
+ "$ref": "BusinessDayConfig",
+ "description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
+ },
+ "transitTimeTable": {
+ "$ref": "TransitTable",
+ "description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both."
+ },
+ "warehouseBasedDeliveryTimes": {
+ "description": "Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set.",
+ "items": {
+ "$ref": "WarehouseBasedDeliveryTime"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Error": {
+ "description": "An error returned by the API.",
+ "id": "Error",
+ "properties": {
+ "domain": {
+ "description": "The domain of the error.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A description of the error.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The error code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Errors": {
+ "description": "A list of errors returned by a failed batch entry.",
+ "id": "Errors",
+ "properties": {
+ "code": {
+ "description": "The HTTP status of the first error in `errors`.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "description": "A list of errors.",
+ "items": {
+ "$ref": "Error"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "The message of the first error in `errors`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GmbAccounts": {
+ "id": "GmbAccounts",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the Merchant Center account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "gmbAccounts": {
+ "description": "A list of GMB accounts which are available to the merchant.",
+ "items": {
+ "$ref": "GmbAccountsGmbAccount"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GmbAccountsGmbAccount": {
+ "id": "GmbAccountsGmbAccount",
+ "properties": {
+ "email": {
+ "description": "The email which identifies the GMB account.",
+ "type": "string"
+ },
+ "listingCount": {
+ "description": "Number of listings under this account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the GMB account.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the GMB account (User or Business).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Headers": {
+ "description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set.",
+ "id": "Headers",
+ "properties": {
+ "locations": {
+ "description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
+ "items": {
+ "$ref": "LocationIdSet"
+ },
+ "type": "array"
+ },
+ "numberOfItems": {
+ "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"<= 10 items\", \"<= 50 items\", and \"> 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "AccountstatusesListResponse": {
- "id": "AccountstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of account statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "AccountStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchRequest": {
- "id": "AccounttaxCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccounttaxCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accounttax request.",
- "id": "AccounttaxCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "type": "string"
- },
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The account tax settings to update. Only defined if the method is `update`."
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchResponse": {
- "id": "AccounttaxCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccounttaxCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accounttax response.",
- "id": "AccounttaxCustomBatchResponseEntry",
- "properties": {
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The retrieved or updated account tax settings."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
+ "postalCodeGroupNames": {
+ "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "prices": {
+ "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"<= $10\", \"<= $500\", and \"> $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
+ "items": {
+ "$ref": "Price"
+ },
+ "type": "array"
+ },
+ "weights": {
+ "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"<= 10kg\", \"<= 50kg\", and \"> 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
+ "items": {
+ "$ref": "Weight"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "HolidayCutoff": {
+ "id": "HolidayCutoff",
+ "properties": {
+ "deadlineDate": {
+ "description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.",
+ "type": "string"
+ },
+ "deadlineHour": {
+ "description": "Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "deadlineTimezone": {
+ "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
+ "type": "string"
+ },
+ "holidayId": {
+ "description": "Unique identifier for the holiday. Required.",
+ "type": "string"
+ },
+ "visibleFromDate": {
+ "description": "Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. \"2016-10-31\" for 31st October 2016. Required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HolidaysHoliday": {
+ "id": "HolidaysHoliday",
+ "properties": {
+ "countryCode": {
+ "description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.",
+ "type": "string"
+ },
+ "date": {
+ "description": "Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present.",
+ "type": "string"
+ },
+ "deliveryGuaranteeDate": {
+ "description": "Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. \"2016-12-24\" for 24th December 2016. Always present.",
+ "type": "string"
+ },
+ "deliveryGuaranteeHour": {
+ "description": "Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InapplicabilityDetails": {
+ "description": "Map of inapplicability details.",
+ "id": "InapplicabilityDetails",
+ "properties": {
+ "inapplicableCount": {
+ "description": "Count of this inapplicable reason code.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inapplicableReason": {
+ "description": "Reason code this rule was not applicable.",
+ "enum": [
+ "INAPPLICABLE_REASON_UNSPECIFIED",
+ "CANNOT_BEAT_BUYBOX_WINNER",
+ "ALREADY_WINNING_BUYBOX",
+ "TRIUMPHED_OVER_BY_SAME_TYPE_RULE",
+ "TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER",
+ "RESTRICTIONS_NOT_MET",
+ "UNCATEGORIZED",
+ "INVALID_AUTO_PRICE_MIN",
+ "INVALID_FLOOR_CONFIG"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used.",
+ "The rule set for this product cannot beat the buybox winner.",
+ "This product can already win the buybox without rule.",
+ "Another rule of the same type takes precedence over this one.",
+ "Another rule of a different type takes precedence over this one.",
+ "The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.",
+ "The reason is not categorized to any known reason.",
+ "The auto_pricing_min_price is invalid. For example, it is missing or < 0.",
+ "The floor defined in the rule is invalid. For example, it has the wrong sign which results in a floor < 0."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Installment": {
+ "id": "Installment",
+ "properties": {
+ "amount": {
+ "$ref": "Price",
+ "description": "The amount the buyer has to pay per month."
+ },
+ "months": {
+ "description": "The number of installments the buyer has to pay.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InvoiceSummary": {
+ "id": "InvoiceSummary",
+ "properties": {
+ "additionalChargeSummaries": {
+ "description": "Summary of the total amounts of the additional charges.",
+ "items": {
+ "$ref": "InvoiceSummaryAdditionalChargeSummary"
+ },
+ "type": "array"
+ },
+ "productTotal": {
+ "$ref": "Amount",
+ "description": "[required] Total price for the product."
+ }
+ },
+ "type": "object"
+ },
+ "InvoiceSummaryAdditionalChargeSummary": {
+ "id": "InvoiceSummaryAdditionalChargeSummary",
+ "properties": {
+ "totalAmount": {
+ "$ref": "Amount",
+ "description": "[required] Total additional charge for this type."
+ },
+ "type": {
+ "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LabelIds": {
+ "description": "The IDs of labels that should be assigned to the CSS domain.",
+ "id": "LabelIds",
+ "properties": {
+ "labelIds": {
+ "description": "The list of label IDs.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LiaAboutPageSettings": {
+ "id": "LiaAboutPageSettings",
+ "properties": {
+ "status": {
+ "description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL for the About page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiaCountrySettings": {
+ "id": "LiaCountrySettings",
+ "properties": {
+ "about": {
+ "$ref": "LiaAboutPageSettings",
+ "description": "The settings for the About page."
+ },
+ "country": {
+ "description": "Required. CLDR country code (e.g. \"US\").",
+ "type": "string"
+ },
+ "hostedLocalStorefrontActive": {
+ "description": "The status of the \"Merchant hosted local storefront\" feature.",
+ "type": "boolean"
+ },
+ "inventory": {
+ "$ref": "LiaInventorySettings",
+ "description": "LIA inventory verification settings."
+ },
+ "onDisplayToOrder": {
+ "$ref": "LiaOnDisplayToOrderSettings",
+ "description": "LIA \"On Display To Order\" settings."
+ },
+ "posDataProvider": {
+ "$ref": "LiaPosDataProvider",
+ "description": "The POS data provider linked with this country."
+ },
+ "storePickupActive": {
+ "description": "The status of the \"Store pickup\" feature.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "LiaInventorySettings": {
+ "id": "LiaInventorySettings",
+ "properties": {
+ "inventoryVerificationContactEmail": {
+ "description": "The email of the contact for the inventory verification process.",
+ "type": "string"
+ },
+ "inventoryVerificationContactName": {
+ "description": "The name of the contact for the inventory verification process.",
+ "type": "string"
+ },
+ "inventoryVerificationContactStatus": {
+ "description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiaOnDisplayToOrderSettings": {
+ "id": "LiaOnDisplayToOrderSettings",
+ "properties": {
+ "shippingCostPolicyUrl": {
+ "description": "Shipping cost and policy URL.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiaPosDataProvider": {
+ "id": "LiaPosDataProvider",
+ "properties": {
+ "posDataProviderId": {
+ "description": "The ID of the POS data provider.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "posExternalAccountId": {
+ "description": "The account ID by which this merchant is known to the POS data provider.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiaSettings": {
+ "description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.",
+ "id": "LiaSettings",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "countrySettings": {
+ "description": "The LIA settings for each country.",
+ "items": {
+ "$ref": "LiaCountrySettings"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchRequest": {
+ "id": "LiasettingsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "LiasettingsCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchRequestEntry": {
+ "id": "LiasettingsCustomBatchRequestEntry",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account LIA settings.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "contactEmail": {
+ "description": "Inventory validation contact email. Required only for SetInventoryValidationContact.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "Inventory validation contact name. Required only for SetInventoryValidationContact.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country code. Required only for RequestInventoryVerification.",
+ "type": "string"
+ },
+ "gmbEmail": {
+ "description": "The GMB account. Required only for RequestGmbAccess.",
+ "type": "string"
+ },
+ "liaSettings": {
+ "$ref": "LiaSettings",
+ "description": "The account Lia settings to update. Only defined if the method is `update`."
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
+ "type": "string"
+ },
+ "posDataProviderId": {
+ "description": "The ID of POS data provider. Required only for SetPosProvider.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "posExternalAccountId": {
+ "description": "The account ID by which this merchant is known to the POS provider.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchResponse": {
+ "id": "LiasettingsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "LiasettingsCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchResponseEntry": {
+ "id": "LiasettingsCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ },
+ "gmbAccounts": {
+ "$ref": "GmbAccounts",
+ "description": "The list of accessible GMB accounts."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "liaSettings": {
+ "$ref": "LiaSettings",
+ "description": "The retrieved or updated Lia settings."
+ },
+ "posDataProviders": {
+ "description": "The list of POS data providers.",
+ "items": {
+ "$ref": "PosDataProviders"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsGetAccessibleGmbAccountsResponse": {
+ "id": "LiasettingsGetAccessibleGmbAccountsResponse",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the Merchant Center account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "gmbAccounts": {
+ "description": "A list of GMB accounts which are available to the merchant.",
+ "items": {
+ "$ref": "GmbAccountsGmbAccount"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsListPosDataProvidersResponse": {
+ "id": "LiasettingsListPosDataProvidersResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\".",
+ "type": "string"
+ },
+ "posDataProviders": {
+ "description": "The list of POS data providers for each eligible country",
+ "items": {
+ "$ref": "PosDataProviders"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsListResponse": {
+ "id": "LiasettingsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of LIA settings.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "LiaSettings"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsRequestGmbAccessResponse": {
+ "id": "LiasettingsRequestGmbAccessResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsRequestInventoryVerificationResponse": {
+ "id": "LiasettingsRequestInventoryVerificationResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsSetInventoryVerificationContactResponse": {
+ "id": "LiasettingsSetInventoryVerificationContactResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsSetPosDataProviderResponse": {
+ "id": "LiasettingsSetPosDataProviderResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LinkService": {
+ "id": "LinkService",
+ "properties": {
+ "service": {
+ "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" - \"`paymentProcessing`\" ",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LinkedAccount": {
+ "id": "LinkedAccount",
+ "properties": {
+ "linkedAccountId": {
+ "description": "The ID of the linked account.",
+ "type": "string"
+ },
+ "services": {
+ "description": "List of provided services.",
+ "items": {
+ "$ref": "LinkService"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListAccountLabelsResponse": {
+ "description": "Response message for the `ListAccountLabels` method.",
+ "id": "ListAccountLabelsResponse",
+ "properties": {
+ "accountLabels": {
+ "description": "The labels from the specified account.",
+ "items": {
+ "$ref": "AccountLabel"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAccountReturnCarrierResponse": {
+ "description": "Response for listing account return carriers.",
+ "id": "ListAccountReturnCarrierResponse",
+ "properties": {
+ "accountReturnCarriers": {
+ "description": "List of all available account return carriers for the merchant.",
+ "items": {
+ "$ref": "AccountReturnCarrier"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListCollectionStatusesResponse": {
+ "description": "Response message for the ListCollectionStatuses method.",
+ "id": "ListCollectionStatusesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "resources": {
+ "description": "The collectionstatuses listed.",
+ "items": {
+ "$ref": "CollectionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListCollectionsResponse": {
+ "description": "Response message for the ListCollections method.",
+ "id": "ListCollectionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "resources": {
+ "description": "The collections listed.",
+ "items": {
+ "$ref": "Collection"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListCssesResponse": {
+ "description": "The response message for the `ListCsses` method",
+ "id": "ListCssesResponse",
+ "properties": {
+ "csses": {
+ "description": "The CSS domains affiliated with the specified CSS group.",
+ "items": {
+ "$ref": "Css"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListRegionsResponse": {
+ "description": "Response message for the `ListRegions` method.",
+ "id": "ListRegionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
},
- "AccounttaxListResponse": {
- "id": "AccounttaxListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of account tax settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "AccountTax"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "regions": {
+ "description": "The regions from the specified merchant.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListRepricingProductReportsResponse": {
+ "description": "Response message for the ListRepricingProductReports method.",
+ "id": "ListRepricingProductReportsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token for retrieving the next page. Its absence means there is no subsequent page.",
+ "type": "string"
+ },
+ "repricingProductReports": {
+ "description": "Periodic reports for the given Repricing product.",
+ "items": {
+ "$ref": "RepricingProductReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListRepricingRuleReportsResponse": {
+ "description": "Response message for the ListRepricingRuleReports method.",
+ "id": "ListRepricingRuleReportsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token for retrieving the next page. Its absence means there is no subsequent page.",
+ "type": "string"
+ },
+ "repricingRuleReports": {
+ "description": "Daily reports for the given Repricing rule.",
+ "items": {
+ "$ref": "RepricingRuleReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListRepricingRulesResponse": {
+ "description": "Response message for the `ListRepricingRules` method.",
+ "id": "ListRepricingRulesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "repricingRules": {
+ "description": "The rules from the specified merchant.",
+ "items": {
+ "$ref": "RepricingRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListReturnPolicyOnlineResponse": {
+ "description": "Response message for the `ListReturnPolicyOnline` method.",
+ "id": "ListReturnPolicyOnlineResponse",
+ "properties": {
+ "returnPolicies": {
+ "description": "The retrieved return policies.",
+ "items": {
+ "$ref": "ReturnPolicyOnline"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LocalInventory": {
+ "description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification.",
+ "id": "LocalInventory",
+ "properties": {
+ "availability": {
+ "description": "Availability of the product. For accepted attribute values, see the local product inventory feed specification.",
+ "type": "string"
+ },
+ "instoreProductLocation": {
+ "description": "In-store product location.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"",
+ "type": "string"
+ },
+ "pickupMethod": {
+ "description": "Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed // specification.",
+ "type": "string"
+ },
+ "pickupSla": {
+ "description": "Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Price of the product."
+ },
+ "quantity": {
+ "description": "Quantity of the product. Must be nonnegative.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "salePrice": {
+ "$ref": "Price",
+ "description": "Sale price of the product. Mandatory if `sale_price_effective_date` is defined."
+ },
+ "salePriceEffectiveDate": {
+ "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. Store code of this local inventory resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocalinventoryCustomBatchRequest": {
+ "id": "LocalinventoryCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "LocalinventoryCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LocalinventoryCustomBatchRequestEntry": {
+ "description": "Batch entry encoding a single local inventory update request.",
+ "id": "LocalinventoryCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "localInventory": {
+ "$ref": "LocalInventory",
+ "description": "Local inventory of the product."
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product for which to update local inventory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocalinventoryCustomBatchResponse": {
+ "id": "LocalinventoryCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "LocalinventoryCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#localinventoryCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocalinventoryCustomBatchResponseEntry": {
+ "description": "Batch entry encoding a single local inventory update response.",
+ "id": "LocalinventoryCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocationIdSet": {
+ "id": "LocationIdSet",
+ "properties": {
+ "locationIds": {
+ "description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LoyaltyPoints": {
+ "id": "LoyaltyPoints",
+ "properties": {
+ "name": {
+ "description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.",
+ "type": "string"
+ },
+ "pointsValue": {
+ "description": "The retailer's loyalty points in absolute value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "ratio": {
+ "description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "MerchantOrderReturn": {
+ "description": "Order return. Production access (all methods) requires the order manager role. Sandbox access does not.",
+ "id": "MerchantOrderReturn",
+ "properties": {
+ "creationDate": {
+ "description": "The date of creation of the return, in ISO 8601 format.",
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "description": "Merchant defined order ID.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "Google order ID.",
+ "type": "string"
+ },
+ "orderReturnId": {
+ "description": "Order return ID generated by Google.",
+ "type": "string"
+ },
+ "returnItems": {
+ "description": "Items of the return.",
+ "items": {
+ "$ref": "MerchantOrderReturnItem"
+ },
+ "type": "array"
+ },
+ "returnPricingInfo": {
+ "$ref": "ReturnPricingInfo",
+ "description": "Information about shipping costs."
+ },
+ "returnShipments": {
+ "description": "Shipments of the return.",
+ "items": {
+ "$ref": "ReturnShipment"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MerchantOrderReturnItem": {
+ "id": "MerchantOrderReturnItem",
+ "properties": {
+ "customerReturnReason": {
+ "$ref": "CustomerReturnReason",
+ "description": "The reason that the customer chooses to return an item."
+ },
+ "itemId": {
+ "description": "Product level item ID. If the returned items are of the same product, they will have the same ID.",
+ "type": "string"
+ },
+ "merchantRejectionReason": {
+ "$ref": "MerchantRejectionReason",
+ "description": "The reason that the merchant chose to reject an item return."
+ },
+ "merchantReturnReason": {
+ "$ref": "RefundReason",
+ "description": "The reason that merchant chooses to accept a return item."
+ },
+ "product": {
+ "$ref": "OrderLineItemProduct",
+ "description": "Product data from the time of the order placement."
+ },
+ "refundableAmount": {
+ "$ref": "MonetaryAmount",
+ "description": "Maximum amount that can be refunded for this return item."
+ },
+ "returnItemId": {
+ "description": "Unit level ID for the return item. Different units of the same product will have different IDs.",
+ "type": "string"
+ },
+ "returnShipmentIds": {
+ "description": "IDs of the return shipments that this return item belongs to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "Amount": {
- "id": "Amount",
- "properties": {
- "priceAmount": {
- "$ref": "Price",
- "description": "[required] The pre-tax or post-tax price depending on the location of the order."
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "[required] Tax value."
- }
- },
- "type": "object"
- },
- "BusinessDayConfig": {
- "id": "BusinessDayConfig",
- "properties": {
- "businessDays": {
- "description": "Regular business days. May not be empty.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "shipmentGroupId": {
+ "description": "ID of the original shipment group. Provided for shipments with invoice support.",
+ "type": "string"
},
- "BuyOnGoogleProgramStatus": {
- "description": "Response message for the GetProgramStatus method.",
- "id": "BuyOnGoogleProgramStatus",
- "properties": {
- "customerServicePendingEmail": {
- "description": "The customer service pending email.",
- "type": "string"
- },
- "customerServiceVerifiedEmail": {
- "description": "The customer service verified email.",
- "type": "string"
- },
- "participationStage": {
- "description": "The current participation stage for the program.",
- "enum": [
- "PROGRAM_PARTICIPATION_STAGE_UNSPECIFIED",
- "NOT_ELIGIBLE",
- "ELIGIBLE",
- "ONBOARDING",
- "ACTIVE",
- "PAUSED"
- ],
- "enumDescriptions": [
- "Default value when participation stage is not set.",
- "Merchant is not eligible for onboarding to a given program in a specific region code.",
- "Merchant is eligible for onboarding to a given program in a specific region code.",
- "Merchant is onboarding to a given program in a specific region code.",
- "Merchant's program participation is active for a specific region code.",
- "Participation has been paused."
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "shipmentUnitId": {
+ "description": "ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.",
+ "type": "string"
},
- "CarrierRate": {
- "id": "CarrierRate",
- "properties": {
- "carrierName": {
- "description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.",
- "type": "string"
- },
- "carrierService": {
- "description": "Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.",
- "type": "string"
- },
- "flatAdjustment": {
- "$ref": "Price",
- "description": "Additive shipping rate modifier. Can be negative. For example `{ \"value\": \"1\", \"currency\" : \"USD\" }` adds $1 to the rate, `{ \"value\": \"-3\", \"currency\" : \"USD\" }` removes $3 from the rate. Optional."
- },
- "name": {
- "description": "Name of the carrier rate. Must be unique per rate group. Required.",
- "type": "string"
- },
- "originPostalCode": {
- "description": "Shipping origin for this carrier rate. Required.",
- "type": "string"
- },
- "percentageAdjustment": {
- "description": "Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `\"5.4\"` increases the rate by 5.4%, `\"-3\"` decreases the rate by 3%. Optional.",
- "type": "string"
- }
- },
- "type": "object"
+ "state": {
+ "description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MerchantRejectionReason": {
+ "id": "MerchantRejectionReason",
+ "properties": {
+ "description": {
+ "description": "Description of the reason.",
+ "type": "string"
+ },
+ "reasonCode": {
+ "description": "Code of the rejection reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metrics": {
+ "description": "Performance metrics. Values are only set for metrics requested explicitly in the request's search query.",
+ "id": "Metrics",
+ "properties": {
+ "clicks": {
+ "description": "Number of clicks.",
+ "format": "int64",
+ "type": "string"
+ },
+ "ctr": {
+ "description": "Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).",
+ "format": "double",
+ "type": "number"
+ },
+ "impressions": {
+ "description": "Number of times merchant's products are shown.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MinimumOrderValueTable": {
+ "id": "MinimumOrderValueTable",
+ "properties": {
+ "storeCodeSetWithMovs": {
+ "items": {
+ "$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MinimumOrderValueTableStoreCodeSetWithMov": {
+ "description": "A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.",
+ "id": "MinimumOrderValueTableStoreCodeSetWithMov",
+ "properties": {
+ "storeCodes": {
+ "description": "A list of unique store codes or empty for the catch all.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "CarriersCarrier": {
- "id": "CarriersCarrier",
- "properties": {
- "country": {
- "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
- "type": "string"
- },
- "name": {
- "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
- "type": "string"
- },
- "services": {
- "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "value": {
+ "$ref": "Price",
+ "description": "The minimum order value for the given stores."
+ }
+ },
+ "type": "object"
+ },
+ "MonetaryAmount": {
+ "id": "MonetaryAmount",
+ "properties": {
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value ."
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`."
+ }
+ },
+ "type": "object"
+ },
+ "OnboardBuyOnGoogleProgramRequest": {
+ "description": "Request message for the OnboardProgram method.",
+ "id": "OnboardBuyOnGoogleProgramRequest",
+ "properties": {
+ "customerServiceEmail": {
+ "description": "The customer service email.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Order": {
+ "description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not.",
+ "id": "Order",
+ "properties": {
+ "acknowledged": {
+ "description": "Whether the order was acknowledged.",
+ "type": "boolean"
+ },
+ "annotations": {
+ "description": "List of key-value pairs that are attached to a given order.",
+ "items": {
+ "$ref": "OrderOrderAnnotation"
+ },
+ "type": "array"
+ },
+ "billingAddress": {
+ "$ref": "OrderAddress",
+ "description": "The billing address."
+ },
+ "customer": {
+ "$ref": "OrderCustomer",
+ "description": "The details of the customer who placed the order."
+ },
+ "deliveryDetails": {
+ "$ref": "OrderDeliveryDetails",
+ "description": "Delivery details for shipments of type `delivery`."
+ },
+ "id": {
+ "description": "The REST ID of the order. Globally unique.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"",
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "Line items that are ordered.",
+ "items": {
+ "$ref": "OrderLineItem"
+ },
+ "type": "array"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "description": "Merchant-provided ID of the order.",
+ "type": "string"
+ },
+ "netPriceAmount": {
+ "$ref": "Price",
+ "description": "The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80."
+ },
+ "netTaxAmount": {
+ "$ref": "Price",
+ "description": "The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds."
+ },
+ "paymentStatus": {
+ "description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ",
+ "type": "string"
+ },
+ "pickupDetails": {
+ "$ref": "OrderPickupDetails",
+ "description": "Pickup details for shipments of type `pickup`."
+ },
+ "placedDate": {
+ "description": "The date when the order was placed, in ISO 8601 format.",
+ "type": "string"
+ },
+ "promotions": {
+ "description": "Promotions associated with the order. To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.",
+ "items": {
+ "$ref": "OrderPromotion"
+ },
+ "type": "array"
+ },
+ "refunds": {
+ "description": "Refunds for the order.",
+ "items": {
+ "$ref": "OrderRefund"
+ },
+ "type": "array"
+ },
+ "shipments": {
+ "description": "Shipments of the order.",
+ "items": {
+ "$ref": "OrderShipment"
+ },
+ "type": "array"
+ },
+ "shippingCost": {
+ "$ref": "Price",
+ "description": "The total cost of shipping for all items."
+ },
+ "shippingCostTax": {
+ "$ref": "Price",
+ "description": "The tax for the total shipping cost."
+ },
+ "status": {
+ "description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" ",
+ "type": "string"
+ },
+ "taxCollector": {
+ "description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderAddress": {
+ "id": "OrderAddress",
+ "properties": {
+ "country": {
+ "description": "CLDR country code (e.g. \"US\").",
+ "type": "string"
+ },
+ "fullAddress": {
+ "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "Collection": {
- "description": "The collection message.",
- "id": "Collection",
- "properties": {
- "customLabel0": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)",
- "type": "string"
- },
- "customLabel1": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel2": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel3": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel4": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "featuredProduct": {
- "description": "This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)",
- "items": {
- "$ref": "CollectionFeaturedProduct"
- },
- "type": "array"
- },
- "headline": {
- "description": "Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)",
- "type": "string"
- },
- "imageLink": {
- "description": "The URL of a collection\u2019s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "language": {
- "description": "The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)",
- "type": "string"
- },
- "link": {
- "description": "A collection\u2019s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)",
- "type": "string"
- },
- "mobileLink": {
- "description": "A collection\u2019s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)",
- "type": "string"
- },
- "productCountry": {
- "description": "[product_country attribute](https://support.google.com/merchants/answer/9674155)",
- "type": "string"
- }
- },
- "type": "object"
+ "isPostOfficeBox": {
+ "description": "Whether the address is a post office box.",
+ "type": "boolean"
},
- "CollectionFeaturedProduct": {
- "description": "The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)",
- "id": "CollectionFeaturedProduct",
- "properties": {
- "offerId": {
- "description": "The unique identifier for the product item.",
- "type": "string"
- },
- "x": {
- "description": "Required. X-coordinate of the product callout on the Shoppable Image.",
- "format": "float",
- "type": "number"
- },
- "y": {
- "description": "Required. Y-coordinate of the product callout on the Shoppable Image.",
- "format": "float",
- "type": "number"
- }
- },
- "type": "object"
- },
- "CollectionStatus": {
- "description": "The collectionstatus message.",
- "id": "CollectionStatus",
- "properties": {
- "collectionLevelIssuses": {
- "description": "A list of all issues associated with the collection.",
- "items": {
- "$ref": "CollectionStatusItemLevelIssue"
- },
- "type": "array"
- },
- "creationDate": {
- "description": "Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- },
- "destinationStatuses": {
- "description": "The intended destinations for the collection.",
- "items": {
- "$ref": "CollectionStatusDestinationStatus"
- },
- "type": "array"
- },
- "id": {
- "description": "Required. The ID of the collection for which status is reported.",
- "type": "string"
- },
- "lastUpdateDate": {
- "description": "Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- }
- },
- "type": "object"
+ "locality": {
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
+ "type": "string"
},
- "CollectionStatusDestinationStatus": {
- "description": "Destination status message.",
- "id": "CollectionStatusDestinationStatus",
- "properties": {
- "destination": {
- "description": "The name of the destination",
- "type": "string"
- },
- "status": {
- "description": "The status for the specified destination.",
- "type": "string"
- }
- },
- "type": "object"
+ "postalCode": {
+ "description": "Postal Code or ZIP (e.g. \"94043\").",
+ "type": "string"
},
- "CollectionStatusItemLevelIssue": {
- "description": "Issue associated with the collection.",
- "id": "CollectionStatusItemLevelIssue",
- "properties": {
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects the serving of the collection.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Css": {
- "description": "Information about CSS domain.",
- "id": "Css",
- "properties": {
- "cssDomainId": {
- "description": "Output only. Immutable. The CSS domain ID.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "displayName": {
- "description": "Output only. Immutable. The CSS domain's display name, used when space is constrained.",
- "readOnly": true,
- "type": "string"
- },
- "fullName": {
- "description": "Output only. Immutable. The CSS domain's full name.",
- "readOnly": true,
- "type": "string"
- },
- "homepageUri": {
- "description": "Output only. Immutable. The CSS domain's homepage.",
- "readOnly": true,
- "type": "string"
- },
- "labelIds": {
- "description": "A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CustomAttribute": {
- "id": "CustomAttribute",
- "properties": {
- "groupValues": {
- "description": "Subattributes within this attribute group. Exactly one of value or groupValues must be provided.",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the attribute. Underscores will be replaced by spaces upon insertion.",
- "type": "string"
- },
- "value": {
- "description": "The value of the attribute.",
- "type": "string"
- }
- },
- "type": "object"
+ "recipientName": {
+ "description": "Name of the recipient.",
+ "type": "string"
},
- "CustomerReturnReason": {
- "id": "CustomerReturnReason",
- "properties": {
- "description": {
- "description": "Description of the reason.",
- "type": "string"
- },
- "reasonCode": {
- "description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "region": {
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
+ "type": "string"
},
- "CutoffTime": {
- "id": "CutoffTime",
- "properties": {
- "hour": {
- "description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "minute": {
- "description": "Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "timezone": {
- "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
- "type": "string"
- }
- },
- "type": "object"
+ "streetAddress": {
+ "description": "Street-level part of the address.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderCancellation": {
+ "id": "OrderCancellation",
+ "properties": {
+ "actor": {
+ "description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
+ "type": "string"
+ },
+ "creationDate": {
+ "description": "Date on which the cancellation has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity that was canceled.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderCustomer": {
+ "id": "OrderCustomer",
+ "properties": {
+ "fullName": {
+ "description": "Full name of the customer.",
+ "type": "string"
+ },
+ "invoiceReceivingEmail": {
+ "description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google.",
+ "type": "string"
+ },
+ "loyaltyInfo": {
+ "$ref": "OrderCustomerLoyaltyInfo",
+ "description": "Loyalty program information."
+ },
+ "marketingRightsInfo": {
+ "$ref": "OrderCustomerMarketingRightsInfo",
+ "description": "Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order."
+ }
+ },
+ "type": "object"
+ },
+ "OrderCustomerLoyaltyInfo": {
+ "id": "OrderCustomerLoyaltyInfo",
+ "properties": {
+ "loyaltyNumber": {
+ "description": "The loyalty card/membership number.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of card/membership holder, this field will be populated when",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderCustomerMarketingRightsInfo": {
+ "id": "OrderCustomerMarketingRightsInfo",
+ "properties": {
+ "explicitMarketingPreference": {
+ "description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - \"`denied`\" - \"`granted`\" ",
+ "type": "string"
+ },
+ "lastUpdatedTimestamp": {
+ "description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.",
+ "type": "string"
+ },
+ "marketingEmailAddress": {
+ "description": "Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDeliveryDetails": {
+ "id": "OrderDeliveryDetails",
+ "properties": {
+ "address": {
+ "$ref": "OrderAddress",
+ "description": "The delivery address"
+ },
+ "phoneNumber": {
+ "description": "The phone number of the person receiving the delivery.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItem": {
+ "id": "OrderLineItem",
+ "properties": {
+ "adjustments": {
+ "description": "Price and tax adjustments applied on the line item.",
+ "items": {
+ "$ref": "OrderLineItemAdjustment"
+ },
+ "type": "array"
+ },
+ "annotations": {
+ "description": "Annotations that are attached to the line item.",
+ "items": {
+ "$ref": "OrderMerchantProvidedAnnotation"
+ },
+ "type": "array"
+ },
+ "cancellations": {
+ "description": "Cancellations of the line item.",
+ "items": {
+ "$ref": "OrderCancellation"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The ID of the line item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
+ },
+ "product": {
+ "$ref": "OrderLineItemProduct",
+ "description": "Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed."
+ },
+ "quantityCanceled": {
+ "description": "Number of items canceled.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityDelivered": {
+ "description": "Number of items delivered.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityOrdered": {
+ "description": "Number of items ordered.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityPending": {
+ "description": "Number of items pending.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityReadyForPickup": {
+ "description": "Number of items ready for pickup.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityReturned": {
+ "description": "Number of items returned.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityShipped": {
+ "description": "Number of items shipped.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "quantityUndeliverable": {
+ "description": "Number of items undeliverable.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "returnInfo": {
+ "$ref": "OrderLineItemReturnInfo",
+ "description": "Details of the return policy for the line item."
+ },
+ "returns": {
+ "description": "Returns of the line item.",
+ "items": {
+ "$ref": "OrderReturn"
+ },
+ "type": "array"
+ },
+ "shippingDetails": {
+ "$ref": "OrderLineItemShippingDetails",
+ "description": "Details of the requested shipping for the line item."
+ },
+ "tax": {
+ "$ref": "Price",
+ "description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemAdjustment": {
+ "id": "OrderLineItemAdjustment",
+ "properties": {
+ "priceAdjustment": {
+ "$ref": "Price",
+ "description": "Adjustment for total price of the line item."
+ },
+ "taxAdjustment": {
+ "$ref": "Price",
+ "description": "Adjustment for total tax of the line item."
+ },
+ "type": {
+ "description": "Type of this adjustment. Acceptable values are: - \"`promotion`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemProduct": {
+ "id": "OrderLineItemProduct",
+ "properties": {
+ "brand": {
+ "description": "Brand of the item.",
+ "type": "string"
+ },
+ "condition": {
+ "description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" ",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "Associated fees at order creation time.",
+ "items": {
+ "$ref": "OrderLineItemProductFee"
+ },
+ "type": "array"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The REST ID of the product.",
+ "type": "string"
+ },
+ "imageLink": {
+ "description": "URL of an image of the item.",
+ "type": "string"
+ },
+ "itemGroupId": {
+ "description": "Shared identifier for all variants of the same product.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "Manufacturer Part Number (MPN) of the item.",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "An identifier of the item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Price of the item."
+ },
+ "shownImage": {
+ "description": "URL to the cached image shown to the user when order was placed.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "The CLDR territory // code of the target country of the product.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the product.",
+ "type": "string"
+ },
+ "variantAttributes": {
+ "description": "Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
+ "items": {
+ "$ref": "OrderLineItemProductVariantAttribute"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemProductFee": {
+ "id": "OrderLineItemProductFee",
+ "properties": {
+ "amount": {
+ "$ref": "Price",
+ "description": "Amount of the fee."
+ },
+ "name": {
+ "description": "Name of the fee.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemProductVariantAttribute": {
+ "id": "OrderLineItemProductVariantAttribute",
+ "properties": {
+ "dimension": {
+ "description": "The dimension of the variant.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value for the dimension.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemReturnInfo": {
+ "id": "OrderLineItemReturnInfo",
+ "properties": {
+ "daysToReturn": {
+ "description": "Required. How many days later the item can be returned.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isReturnable": {
+ "description": "Required. Whether the item is returnable.",
+ "type": "boolean"
+ },
+ "policyUrl": {
+ "description": "Required. URL of the item return policy.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemShippingDetails": {
+ "id": "OrderLineItemShippingDetails",
+ "properties": {
+ "deliverByDate": {
+ "description": "Required. The delivery by date, in ISO 8601 format.",
+ "type": "string"
+ },
+ "method": {
+ "$ref": "OrderLineItemShippingDetailsMethod",
+ "description": "Required. Details of the shipping method."
+ },
+ "pickupPromiseInMinutes": {
+ "description": "The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "shipByDate": {
+ "description": "Required. The ship by date, in ISO 8601 format.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderLineItemShippingDetailsMethod": {
+ "id": "OrderLineItemShippingDetailsMethod",
+ "properties": {
+ "carrier": {
+ "description": "The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.",
+ "type": "string"
+ },
+ "maxDaysInTransit": {
+ "description": "Required. Maximum transit time.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "methodName": {
+ "description": "Required. The name of the shipping method.",
+ "type": "string"
+ },
+ "minDaysInTransit": {
+ "description": "Required. Minimum transit time.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrderMerchantProvidedAnnotation": {
+ "id": "OrderMerchantProvidedAnnotation",
+ "properties": {
+ "key": {
+ "description": "Key for additional merchant provided (as key-value pairs) annotation about the line item.",
+ "type": "string"
},
- "Datafeed": {
- "description": "Datafeed configuration data.",
- "id": "Datafeed",
- "properties": {
- "attributeLanguage": {
- "description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
- "type": "string"
- },
- "contentType": {
- "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" ",
- "type": "string"
- },
- "fetchSchedule": {
- "$ref": "DatafeedFetchSchedule",
- "description": "Fetch schedule for the feed file."
- },
- "fileName": {
- "description": "Required. The filename of the feed. All feeds must have a unique file name.",
- "type": "string"
- },
- "format": {
- "$ref": "DatafeedFormat",
- "description": "Format of the feed file."
- },
- "id": {
- "description": "Required for update. The ID of the data feed.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\"",
- "type": "string"
- },
- "name": {
- "description": "Required for insert. A descriptive name of the data feed.",
- "type": "string"
- },
- "targets": {
- "description": "The targets this feed should apply to (country, language, destinations).",
- "items": {
- "$ref": "DatafeedTarget"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "value": {
+ "description": "Value for additional merchant provided (as key-value pairs) annotation about the line item.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderOrderAnnotation": {
+ "id": "OrderOrderAnnotation",
+ "properties": {
+ "key": {
+ "description": "Key for additional google provided (as key-value pairs) annotation.",
+ "type": "string"
},
- "DatafeedFetchSchedule": {
- "description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.",
- "id": "DatafeedFetchSchedule",
- "properties": {
- "dayOfMonth": {
- "description": "The day of the month the feed file should be fetched (1-31).",
- "format": "uint32",
- "type": "integer"
- },
- "fetchUrl": {
- "description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
- "type": "string"
- },
- "hour": {
- "description": "The hour of the day the feed file should be fetched (0-23).",
- "format": "uint32",
- "type": "integer"
- },
- "minuteOfHour": {
- "description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
- "format": "uint32",
- "type": "integer"
- },
- "password": {
- "description": "An optional password for fetch_url.",
- "type": "string"
- },
- "paused": {
- "description": "Whether the scheduled fetch is paused or not.",
- "type": "boolean"
- },
- "timeZone": {
- "description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".",
- "type": "string"
- },
- "username": {
- "description": "An optional user name for fetch_url.",
- "type": "string"
- },
- "weekday": {
- "description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedFormat": {
- "id": "DatafeedFormat",
- "properties": {
- "columnDelimiter": {
- "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" ",
- "type": "string"
- },
- "fileEncoding": {
- "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ",
- "type": "string"
- },
- "quotingMode": {
- "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedStatus": {
- "description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
- "id": "DatafeedStatus",
- "properties": {
- "country": {
- "description": "The country for which the status is reported, represented as a CLDR territory code.",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the feed for which the status is reported.",
- "format": "uint64",
- "type": "string"
- },
- "errors": {
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- },
- "type": "array"
- },
- "itemsTotal": {
- "description": "The number of items in the feed that were processed.",
- "format": "uint64",
- "type": "string"
- },
- "itemsValid": {
- "description": "The number of items in the feed that were valid.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"",
- "type": "string"
- },
- "language": {
- "description": "The two-letter ISO 639-1 language for which the status is reported.",
- "type": "string"
- },
- "lastUploadDate": {
- "description": "The last date at which the feed was uploaded.",
- "type": "string"
- },
- "processingStatus": {
- "description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. ",
- "type": "string"
- },
- "warnings": {
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedStatusError": {
- "description": "An error occurring in the feed, like \"invalid price\".",
- "id": "DatafeedStatusError",
- "properties": {
- "code": {
- "description": "The code of the error, e.g., \"validation/invalid_value\".",
- "type": "string"
- },
- "count": {
- "description": "The number of occurrences of the error in the feed.",
- "format": "uint64",
- "type": "string"
- },
- "examples": {
- "description": "A list of example occurrences of the error, grouped by product.",
- "items": {
- "$ref": "DatafeedStatusExample"
- },
- "type": "array"
- },
- "message": {
- "description": "The error message, e.g., \"Invalid price\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedStatusExample": {
- "description": "An example occurrence for a particular error.",
- "id": "DatafeedStatusExample",
- "properties": {
- "itemId": {
- "description": "The ID of the example item.",
- "type": "string"
- },
- "lineNumber": {
- "description": "Line number in the data feed where the example is found.",
- "format": "uint64",
- "type": "string"
- },
- "value": {
- "description": "The problematic value.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedTarget": {
- "id": "DatafeedTarget",
- "properties": {
- "country": {
- "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code.",
- "type": "string"
- },
- "excludedDestinations": {
- "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "includedDestinations": {
- "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle ",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "language": {
- "description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchRequest": {
- "id": "DatafeedsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch datafeeds request.",
- "id": "DatafeedsCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The data feed to insert."
- },
- "datafeedId": {
- "description": "The ID of the data feed to get, delete or fetch.",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchResponse": {
- "id": "DatafeedsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch datafeeds response.",
- "id": "DatafeedsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The requested data feed. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- },
- "type": "object"
- },
- "DatafeedsFetchNowResponse": {
- "id": "DatafeedsFetchNowResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsListResponse": {
- "id": "DatafeedsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of datafeeds.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Datafeed"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchRequest": {
- "id": "DatafeedstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch datafeedstatuses request.",
- "id": "DatafeedstatusesCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "country": {
- "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required.",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the data feed to get.",
- "format": "uint64",
- "type": "string"
- },
- "language": {
- "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchResponse": {
- "id": "DatafeedstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch datafeedstatuses response.",
- "id": "DatafeedstatusesCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeedStatus": {
- "$ref": "DatafeedStatus",
- "description": "The requested data feed status. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- },
- "type": "object"
- },
- "DatafeedstatusesListResponse": {
- "id": "DatafeedstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of datafeed statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "DatafeedStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Date": {
- "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
- "id": "Date",
- "properties": {
- "day": {
- "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
- "format": "int32",
- "type": "integer"
- },
- "year": {
- "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DateTime": {
- "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
- "id": "DateTime",
- "properties": {
- "day": {
- "description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.",
- "format": "int32",
- "type": "integer"
- },
- "hours": {
- "description": "Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "minutes": {
- "description": "Required. Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Required. Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "description": "Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
- "format": "int32",
- "type": "integer"
- },
- "timeZone": {
- "$ref": "TimeZone",
- "description": "Time zone."
- },
- "utcOffset": {
- "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
- "format": "google-duration",
- "type": "string"
- },
- "year": {
- "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DeliveryTime": {
- "id": "DeliveryTime",
- "properties": {
- "cutoffTime": {
- "$ref": "CutoffTime",
- "description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
- },
- "handlingBusinessDayConfig": {
- "$ref": "BusinessDayConfig",
- "description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
- },
- "holidayCutoffs": {
- "description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
- "items": {
- "$ref": "HolidayCutoff"
- },
- "type": "array"
- },
- "maxHandlingTimeInDays": {
- "description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "maxTransitTimeInDays": {
- "description": "Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "minHandlingTimeInDays": {
- "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.",
- "format": "uint32",
- "type": "integer"
- },
- "minTransitTimeInDays": {
- "description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.",
- "format": "uint32",
- "type": "integer"
- },
- "transitBusinessDayConfig": {
- "$ref": "BusinessDayConfig",
- "description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
- },
- "transitTimeTable": {
- "$ref": "TransitTable",
- "description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both."
- }
- },
- "type": "object"
- },
- "Error": {
- "description": "An error returned by the API.",
- "id": "Error",
- "properties": {
- "domain": {
- "description": "The domain of the error.",
- "type": "string"
- },
- "message": {
- "description": "A description of the error.",
- "type": "string"
- },
- "reason": {
- "description": "The error code.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Errors": {
- "description": "A list of errors returned by a failed batch entry.",
- "id": "Errors",
- "properties": {
- "code": {
- "description": "The HTTP status of the first error in `errors`.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "description": "A list of errors.",
- "items": {
- "$ref": "Error"
- },
- "type": "array"
- },
- "message": {
- "description": "The message of the first error in `errors`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GmbAccounts": {
- "id": "GmbAccounts",
- "properties": {
- "accountId": {
- "description": "The ID of the Merchant Center account.",
- "format": "uint64",
- "type": "string"
- },
- "gmbAccounts": {
- "description": "A list of GMB accounts which are available to the merchant.",
- "items": {
- "$ref": "GmbAccountsGmbAccount"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GmbAccountsGmbAccount": {
- "id": "GmbAccountsGmbAccount",
- "properties": {
- "email": {
- "description": "The email which identifies the GMB account.",
- "type": "string"
- },
- "listingCount": {
- "description": "Number of listings under this account.",
- "format": "uint64",
- "type": "string"
- },
- "name": {
- "description": "The name of the GMB account.",
- "type": "string"
- },
- "type": {
- "description": "The type of the GMB account (User or Business).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Headers": {
- "description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set.",
- "id": "Headers",
- "properties": {
- "locations": {
- "description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "LocationIdSet"
- },
- "type": "array"
- },
- "numberOfItems": {
- "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"<= 10 items\", \"<= 50 items\", and \"> 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "postalCodeGroupNames": {
- "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "prices": {
- "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"<= $10\", \"<= $500\", and \"> $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "Price"
- },
- "type": "array"
- },
- "weights": {
- "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"<= 10kg\", \"<= 50kg\", and \"> 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "Weight"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "HolidayCutoff": {
- "id": "HolidayCutoff",
- "properties": {
- "deadlineDate": {
- "description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.",
- "type": "string"
- },
- "deadlineHour": {
- "description": "Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "deadlineTimezone": {
- "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
- "type": "string"
- },
- "holidayId": {
- "description": "Unique identifier for the holiday. Required.",
- "type": "string"
- },
- "visibleFromDate": {
- "description": "Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. \"2016-10-31\" for 31st October 2016. Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "HolidaysHoliday": {
- "id": "HolidaysHoliday",
- "properties": {
- "countryCode": {
- "description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.",
- "type": "string"
- },
- "date": {
- "description": "Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present.",
- "type": "string"
- },
- "deliveryGuaranteeDate": {
- "description": "Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. \"2016-12-24\" for 24th December 2016. Always present.",
- "type": "string"
- },
- "deliveryGuaranteeHour": {
- "description": "Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.",
- "format": "uint64",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
- "type": "string"
- },
- "type": {
- "description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InapplicabilityDetails": {
- "description": "Map of inapplicability details.",
- "id": "InapplicabilityDetails",
- "properties": {
- "inapplicableCount": {
- "description": "Count of this inapplicable reason code.",
- "format": "int64",
- "type": "string"
- },
- "inapplicableReason": {
- "description": "Reason code this rule was not applicable.",
- "enum": [
- "INAPPLICABLE_REASON_UNSPECIFIED",
- "CANNOT_BEAT_BUYBOX_WINNER",
- "ALREADY_WINNING_BUYBOX",
- "TRIUMPHED_OVER_BY_SAME_TYPE_RULE",
- "TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER",
- "RESTRICTIONS_NOT_MET",
- "UNCATEGORIZED"
- ],
- "enumDescriptions": [
- "Default value. Should not be used.",
- "The rule set for this product cannot beat the buybox winner.",
- "This product can already win the buybox without rule.",
- "Another rule of the same type takes precedence over this one.",
- "Another rule of a different type takes precedence over this one.",
- "The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.",
- "The reason is not categorized to any known reason."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "Installment": {
- "id": "Installment",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount the buyer has to pay per month."
- },
- "months": {
- "description": "The number of installments the buyer has to pay.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InvoiceSummary": {
- "id": "InvoiceSummary",
- "properties": {
- "additionalChargeSummaries": {
- "description": "Summary of the total amounts of the additional charges.",
- "items": {
- "$ref": "InvoiceSummaryAdditionalChargeSummary"
- },
- "type": "array"
- },
- "productTotal": {
- "$ref": "Amount",
- "description": "[required] Total price for the product."
- }
- },
- "type": "object"
- },
- "InvoiceSummaryAdditionalChargeSummary": {
- "id": "InvoiceSummaryAdditionalChargeSummary",
- "properties": {
- "totalAmount": {
- "$ref": "Amount",
- "description": "[required] Total additional charge for this type."
- },
- "type": {
- "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LabelIds": {
- "description": "The IDs of labels that should be assigned to the CSS domain.",
- "id": "LabelIds",
- "properties": {
- "labelIds": {
- "description": "The list of label IDs.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiaAboutPageSettings": {
- "id": "LiaAboutPageSettings",
- "properties": {
- "status": {
- "description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- },
- "url": {
- "description": "The URL for the About page.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaCountrySettings": {
- "id": "LiaCountrySettings",
- "properties": {
- "about": {
- "$ref": "LiaAboutPageSettings",
- "description": "The settings for the About page."
- },
- "country": {
- "description": "Required. CLDR country code (e.g. \"US\").",
- "type": "string"
- },
- "hostedLocalStorefrontActive": {
- "description": "The status of the \"Merchant hosted local storefront\" feature.",
- "type": "boolean"
- },
- "inventory": {
- "$ref": "LiaInventorySettings",
- "description": "LIA inventory verification settings."
- },
- "onDisplayToOrder": {
- "$ref": "LiaOnDisplayToOrderSettings",
- "description": "LIA \"On Display To Order\" settings."
- },
- "posDataProvider": {
- "$ref": "LiaPosDataProvider",
- "description": "The POS data provider linked with this country."
- },
- "storePickupActive": {
- "description": "The status of the \"Store pickup\" feature.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "LiaInventorySettings": {
- "id": "LiaInventorySettings",
- "properties": {
- "inventoryVerificationContactEmail": {
- "description": "The email of the contact for the inventory verification process.",
- "type": "string"
- },
- "inventoryVerificationContactName": {
- "description": "The name of the contact for the inventory verification process.",
- "type": "string"
- },
- "inventoryVerificationContactStatus": {
- "description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- },
- "status": {
- "description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaOnDisplayToOrderSettings": {
- "id": "LiaOnDisplayToOrderSettings",
- "properties": {
- "shippingCostPolicyUrl": {
- "description": "Shipping cost and policy URL.",
- "type": "string"
- },
- "status": {
- "description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaPosDataProvider": {
- "id": "LiaPosDataProvider",
- "properties": {
- "posDataProviderId": {
- "description": "The ID of the POS data provider.",
- "format": "uint64",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS data provider.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaSettings": {
- "description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.",
- "id": "LiaSettings",
- "properties": {
- "accountId": {
- "description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.",
- "format": "uint64",
- "type": "string"
- },
- "countrySettings": {
- "description": "The LIA settings for each country.",
- "items": {
- "$ref": "LiaCountrySettings"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchRequest": {
- "id": "LiasettingsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "LiasettingsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchRequestEntry": {
- "id": "LiasettingsCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account LIA settings.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "contactEmail": {
- "description": "Inventory validation contact email. Required only for SetInventoryValidationContact.",
- "type": "string"
- },
- "contactName": {
- "description": "Inventory validation contact name. Required only for SetInventoryValidationContact.",
- "type": "string"
- },
- "country": {
- "description": "The country code. Required only for RequestInventoryVerification.",
- "type": "string"
- },
- "gmbEmail": {
- "description": "The GMB account. Required only for RequestGmbAccess.",
- "type": "string"
- },
- "liaSettings": {
- "$ref": "LiaSettings",
- "description": "The account Lia settings to update. Only defined if the method is `update`."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
- "type": "string"
- },
- "posDataProviderId": {
- "description": "The ID of POS data provider. Required only for SetPosProvider.",
- "format": "uint64",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS provider.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchResponse": {
- "id": "LiasettingsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "LiasettingsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchResponseEntry": {
- "id": "LiasettingsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "gmbAccounts": {
- "$ref": "GmbAccounts",
- "description": "The list of accessible GMB accounts."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "liaSettings": {
- "$ref": "LiaSettings",
- "description": "The retrieved or updated Lia settings."
- },
- "posDataProviders": {
- "description": "The list of POS data providers.",
- "items": {
- "$ref": "PosDataProviders"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsGetAccessibleGmbAccountsResponse": {
- "id": "LiasettingsGetAccessibleGmbAccountsResponse",
- "properties": {
- "accountId": {
- "description": "The ID of the Merchant Center account.",
- "format": "uint64",
- "type": "string"
- },
- "gmbAccounts": {
- "description": "A list of GMB accounts which are available to the merchant.",
- "items": {
- "$ref": "GmbAccountsGmbAccount"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsListPosDataProvidersResponse": {
- "id": "LiasettingsListPosDataProvidersResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\".",
- "type": "string"
- },
- "posDataProviders": {
- "description": "The list of POS data providers for each eligible country",
- "items": {
- "$ref": "PosDataProviders"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsListResponse": {
- "id": "LiasettingsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of LIA settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "LiaSettings"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsRequestGmbAccessResponse": {
- "id": "LiasettingsRequestGmbAccessResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsRequestInventoryVerificationResponse": {
- "id": "LiasettingsRequestInventoryVerificationResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsSetInventoryVerificationContactResponse": {
- "id": "LiasettingsSetInventoryVerificationContactResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsSetPosDataProviderResponse": {
- "id": "LiasettingsSetPosDataProviderResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LinkService": {
- "id": "LinkService",
- "properties": {
- "service": {
- "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" ",
- "type": "string"
- },
- "status": {
- "description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LinkedAccount": {
- "id": "LinkedAccount",
- "properties": {
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "services": {
- "description": "List of provided services.",
- "items": {
- "$ref": "LinkService"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListAccountLabelsResponse": {
- "description": "Response message for the `ListAccountLabels` method.",
- "id": "ListAccountLabelsResponse",
- "properties": {
- "accountLabels": {
- "description": "The labels from the specified account.",
- "items": {
- "$ref": "AccountLabel"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListAccountReturnCarrierResponse": {
- "description": "Response for listing account return carriers.",
- "id": "ListAccountReturnCarrierResponse",
- "properties": {
- "accountReturnCarriers": {
- "description": "List of all available account return carriers for the merchant.",
- "items": {
- "$ref": "AccountReturnCarrier"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListCollectionStatusesResponse": {
- "description": "Response message for the ListCollectionStatuses method.",
- "id": "ListCollectionStatusesResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "resources": {
- "description": "The collectionstatuses listed.",
- "items": {
- "$ref": "CollectionStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListCollectionsResponse": {
- "description": "Response message for the ListCollections method.",
- "id": "ListCollectionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "resources": {
- "description": "The collections listed.",
- "items": {
- "$ref": "Collection"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListCssesResponse": {
- "description": "The response message for the `ListCsses` method",
- "id": "ListCssesResponse",
- "properties": {
- "csses": {
- "description": "The CSS domains affiliated with the specified CSS group.",
- "items": {
- "$ref": "Css"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListRegionsResponse": {
- "description": "Response message for the `ListRegions` method.",
- "id": "ListRegionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "regions": {
- "description": "The regions from the specified merchant.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListRepricingProductReportsResponse": {
- "description": "Response message for the ListRepricingProductReports method.",
- "id": "ListRepricingProductReportsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token for retrieving the next page. Its absence means there is no subsequent page.",
- "type": "string"
- },
- "repricingProductReports": {
- "description": "Periodic reports for the given Repricing product.",
- "items": {
- "$ref": "RepricingProductReport"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListRepricingRuleReportsResponse": {
- "description": "Response message for the ListRepricingRuleReports method.",
- "id": "ListRepricingRuleReportsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token for retrieving the next page. Its absence means there is no subsequent page.",
- "type": "string"
- },
- "repricingRuleReports": {
- "description": "Daily reports for the given Repricing rule.",
- "items": {
- "$ref": "RepricingRuleReport"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListRepricingRulesResponse": {
- "description": "Response message for the `ListRepricingRules` method.",
- "id": "ListRepricingRulesResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "repricingRules": {
- "description": "The rules from the specified merchant.",
- "items": {
- "$ref": "RepricingRule"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListReturnPolicyOnlineResponse": {
- "description": "Response message for the `ListReturnPolicyOnline` method.",
- "id": "ListReturnPolicyOnlineResponse",
- "properties": {
- "returnPolicies": {
- "description": "The retrieved return policies.",
- "items": {
- "$ref": "ReturnPolicyOnline"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LocalInventory": {
- "description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification.",
- "id": "LocalInventory",
- "properties": {
- "availability": {
- "description": "Availability of the product. For accepted attribute values, see the local product inventory feed specification.",
- "type": "string"
- },
- "instoreProductLocation": {
- "description": "In-store product location.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"",
- "type": "string"
- },
- "pickupMethod": {
- "description": "Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed // specification.",
- "type": "string"
- },
- "pickupSla": {
- "description": "Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the product."
- },
- "quantity": {
- "description": "Quantity of the product. Must be nonnegative.",
- "format": "uint32",
- "type": "integer"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "Sale price of the product. Mandatory if `sale_price_effective_date` is defined."
- },
- "salePriceEffectiveDate": {
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. Store code of this local inventory resource.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchRequest": {
- "id": "LocalinventoryCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "LocalinventoryCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchRequestEntry": {
- "description": "Batch entry encoding a single local inventory update request.",
- "id": "LocalinventoryCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "localInventory": {
- "$ref": "LocalInventory",
- "description": "Local inventory of the product."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which to update local inventory.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchResponse": {
- "id": "LocalinventoryCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "LocalinventoryCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#localinventoryCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchResponseEntry": {
- "description": "Batch entry encoding a single local inventory update response.",
- "id": "LocalinventoryCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocationIdSet": {
- "id": "LocationIdSet",
- "properties": {
- "locationIds": {
- "description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LoyaltyPoints": {
- "id": "LoyaltyPoints",
- "properties": {
- "name": {
- "description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.",
- "type": "string"
- },
- "pointsValue": {
- "description": "The retailer's loyalty points in absolute value.",
- "format": "int64",
- "type": "string"
- },
- "ratio": {
- "description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "MerchantOrderReturn": {
- "description": "Order return. Production access (all methods) requires the order manager role. Sandbox access does not.",
- "id": "MerchantOrderReturn",
- "properties": {
- "creationDate": {
- "description": "The date of creation of the return, in ISO 8601 format.",
- "type": "string"
- },
- "merchantOrderId": {
- "description": "Merchant defined order ID.",
- "type": "string"
- },
- "orderId": {
- "description": "Google order ID.",
- "type": "string"
- },
- "orderReturnId": {
- "description": "Order return ID generated by Google.",
- "type": "string"
- },
- "returnItems": {
- "description": "Items of the return.",
- "items": {
- "$ref": "MerchantOrderReturnItem"
- },
- "type": "array"
- },
- "returnPricingInfo": {
- "$ref": "ReturnPricingInfo",
- "description": "Information about shipping costs."
- },
- "returnShipments": {
- "description": "Shipments of the return.",
- "items": {
- "$ref": "ReturnShipment"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "MerchantOrderReturnItem": {
- "id": "MerchantOrderReturnItem",
- "properties": {
- "customerReturnReason": {
- "$ref": "CustomerReturnReason",
- "description": "The reason that the customer chooses to return an item."
- },
- "itemId": {
- "description": "Product level item ID. If the returned items are of the same product, they will have the same ID.",
- "type": "string"
- },
- "merchantRejectionReason": {
- "$ref": "MerchantRejectionReason",
- "description": "The reason that the merchant chose to reject an item return."
- },
- "merchantReturnReason": {
- "$ref": "RefundReason",
- "description": "The reason that merchant chooses to accept a return item."
- },
- "product": {
- "$ref": "OrderLineItemProduct",
- "description": "Product data from the time of the order placement."
- },
- "refundableAmount": {
- "$ref": "MonetaryAmount",
- "description": "Maximum amount that can be refunded for this return item."
- },
- "returnItemId": {
- "description": "Unit level ID for the return item. Different units of the same product will have different IDs.",
- "type": "string"
- },
- "returnShipmentIds": {
- "description": "IDs of the return shipments that this return item belongs to.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "shipmentGroupId": {
- "description": "ID of the original shipment group. Provided for shipments with invoice support.",
- "type": "string"
- },
- "shipmentUnitId": {
- "description": "ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.",
- "type": "string"
- },
- "state": {
- "description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "MerchantRejectionReason": {
- "id": "MerchantRejectionReason",
- "properties": {
- "description": {
- "description": "Description of the reason.",
- "type": "string"
- },
- "reasonCode": {
- "description": "Code of the rejection reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Metrics": {
- "description": "Performance metrics. Values are only set for metrics requested explicitly in the request's search query.",
- "id": "Metrics",
- "properties": {
- "clicks": {
- "description": "Number of clicks.",
- "format": "int64",
- "type": "string"
- },
- "ctr": {
- "description": "Number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).",
- "format": "double",
- "type": "number"
- },
- "impressions": {
- "description": "Number of times merchant's products are shown.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "MinimumOrderValueTable": {
- "id": "MinimumOrderValueTable",
- "properties": {
- "storeCodeSetWithMovs": {
- "items": {
- "$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "MinimumOrderValueTableStoreCodeSetWithMov": {
- "description": "A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.",
- "id": "MinimumOrderValueTableStoreCodeSetWithMov",
- "properties": {
- "storeCodes": {
- "description": "A list of unique store codes or empty for the catch all.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "value": {
- "$ref": "Price",
- "description": "The minimum order value for the given stores."
- }
- },
- "type": "object"
- },
- "MonetaryAmount": {
- "id": "MonetaryAmount",
- "properties": {
- "priceAmount": {
- "$ref": "Price",
- "description": "The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value ."
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`."
- }
- },
- "type": "object"
- },
- "OnboardBuyOnGoogleProgramRequest": {
- "description": "Request message for the OnboardProgram method.",
- "id": "OnboardBuyOnGoogleProgramRequest",
- "properties": {
- "customerServiceEmail": {
- "description": "The customer service email.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Order": {
- "description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not.",
- "id": "Order",
- "properties": {
- "acknowledged": {
- "description": "Whether the order was acknowledged.",
- "type": "boolean"
- },
- "annotations": {
- "description": "List of key-value pairs that are attached to a given order.",
- "items": {
- "$ref": "OrderOrderAnnotation"
- },
- "type": "array"
- },
- "billingAddress": {
- "$ref": "OrderAddress",
- "description": "The billing address."
- },
- "customer": {
- "$ref": "OrderCustomer",
- "description": "The details of the customer who placed the order."
- },
- "deliveryDetails": {
- "$ref": "OrderDeliveryDetails",
- "description": "Delivery details for shipments of type `delivery`."
- },
- "id": {
- "description": "The REST ID of the order. Globally unique.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"",
- "type": "string"
- },
- "lineItems": {
- "description": "Line items that are ordered.",
- "items": {
- "$ref": "OrderLineItem"
- },
- "type": "array"
- },
- "merchantId": {
- "format": "uint64",
- "type": "string"
- },
- "merchantOrderId": {
- "description": "Merchant-provided ID of the order.",
- "type": "string"
- },
- "netPriceAmount": {
- "$ref": "Price",
- "description": "The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80."
- },
- "netTaxAmount": {
- "$ref": "Price",
- "description": "The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds."
- },
- "paymentStatus": {
- "description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ",
- "type": "string"
- },
- "pickupDetails": {
- "$ref": "OrderPickupDetails",
- "description": "Pickup details for shipments of type `pickup`."
- },
- "placedDate": {
- "description": "The date when the order was placed, in ISO 8601 format.",
- "type": "string"
- },
- "promotions": {
- "description": "Promotions associated with the order. To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.",
- "items": {
- "$ref": "OrderPromotion"
- },
- "type": "array"
- },
- "refunds": {
- "description": "Refunds for the order.",
- "items": {
- "$ref": "OrderRefund"
- },
- "type": "array"
- },
- "shipments": {
- "description": "Shipments of the order.",
- "items": {
- "$ref": "OrderShipment"
- },
- "type": "array"
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "The total cost of shipping for all items."
- },
- "shippingCostTax": {
- "$ref": "Price",
- "description": "The tax for the total shipping cost."
- },
- "status": {
- "description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" ",
- "type": "string"
- },
- "taxCollector": {
- "description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderAddress": {
- "id": "OrderAddress",
- "properties": {
- "country": {
- "description": "CLDR country code (e.g. \"US\").",
- "type": "string"
- },
- "fullAddress": {
- "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "isPostOfficeBox": {
- "description": "Whether the address is a post office box.",
- "type": "boolean"
- },
- "locality": {
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal Code or ZIP (e.g. \"94043\").",
- "type": "string"
- },
- "recipientName": {
- "description": "Name of the recipient.",
- "type": "string"
- },
- "region": {
- "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
- },
- "streetAddress": {
- "description": "Street-level part of the address.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderCancellation": {
- "id": "OrderCancellation",
- "properties": {
- "actor": {
- "description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
- "type": "string"
- },
- "creationDate": {
- "description": "Date on which the cancellation has been created, in ISO 8601 format.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity that was canceled.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderCustomer": {
- "id": "OrderCustomer",
- "properties": {
- "fullName": {
- "description": "Full name of the customer.",
- "type": "string"
- },
- "invoiceReceivingEmail": {
- "description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google.",
- "type": "string"
- },
- "loyaltyInfo": {
- "$ref": "OrderCustomerLoyaltyInfo",
- "description": "Loyalty program information."
- },
- "marketingRightsInfo": {
- "$ref": "OrderCustomerMarketingRightsInfo",
- "description": "Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order."
- }
- },
- "type": "object"
- },
- "OrderCustomerLoyaltyInfo": {
- "id": "OrderCustomerLoyaltyInfo",
- "properties": {
- "loyaltyNumber": {
- "description": "The loyalty card/membership number.",
- "type": "string"
- },
- "name": {
- "description": "Name of card/membership holder, this field will be populated when",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderCustomerMarketingRightsInfo": {
- "id": "OrderCustomerMarketingRightsInfo",
- "properties": {
- "explicitMarketingPreference": {
- "description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - \"`denied`\" - \"`granted`\" ",
- "type": "string"
- },
- "lastUpdatedTimestamp": {
- "description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.",
- "type": "string"
- },
- "marketingEmailAddress": {
- "description": "Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderDeliveryDetails": {
- "id": "OrderDeliveryDetails",
- "properties": {
- "address": {
- "$ref": "OrderAddress",
- "description": "The delivery address"
- },
- "phoneNumber": {
- "description": "The phone number of the person receiving the delivery.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItem": {
- "id": "OrderLineItem",
- "properties": {
- "adjustments": {
- "description": "Price and tax adjustments applied on the line item.",
- "items": {
- "$ref": "OrderLineItemAdjustment"
- },
- "type": "array"
- },
- "annotations": {
- "description": "Annotations that are attached to the line item.",
- "items": {
- "$ref": "OrderMerchantProvidedAnnotation"
- },
- "type": "array"
- },
- "cancellations": {
- "description": "Cancellations of the line item.",
- "items": {
- "$ref": "OrderCancellation"
- },
- "type": "array"
- },
- "id": {
- "description": "The ID of the line item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
- },
- "product": {
- "$ref": "OrderLineItemProduct",
- "description": "Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed."
- },
- "quantityCanceled": {
- "description": "Number of items canceled.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityDelivered": {
- "description": "Number of items delivered.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityOrdered": {
- "description": "Number of items ordered.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityPending": {
- "description": "Number of items pending.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityReadyForPickup": {
- "description": "Number of items ready for pickup.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityReturned": {
- "description": "Number of items returned.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityShipped": {
- "description": "Number of items shipped.",
- "format": "uint32",
- "type": "integer"
- },
- "quantityUndeliverable": {
- "description": "Number of items undeliverable.",
- "format": "uint32",
- "type": "integer"
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Details of the return policy for the line item."
- },
- "returns": {
- "description": "Returns of the line item.",
- "items": {
- "$ref": "OrderReturn"
- },
- "type": "array"
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Details of the requested shipping for the line item."
- },
- "tax": {
- "$ref": "Price",
- "description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
- }
- },
- "type": "object"
- },
- "OrderLineItemAdjustment": {
- "id": "OrderLineItemAdjustment",
- "properties": {
- "priceAdjustment": {
- "$ref": "Price",
- "description": "Adjustment for total price of the line item."
- },
- "taxAdjustment": {
- "$ref": "Price",
- "description": "Adjustment for total tax of the line item."
- },
- "type": {
- "description": "Type of this adjustment. Acceptable values are: - \"`promotion`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItemProduct": {
- "id": "OrderLineItemProduct",
- "properties": {
- "brand": {
- "description": "Brand of the item.",
- "type": "string"
- },
- "condition": {
- "description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" ",
- "type": "string"
- },
- "contentLanguage": {
- "description": "The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "fees": {
- "description": "Associated fees at order creation time.",
- "items": {
- "$ref": "OrderLineItemProductFee"
- },
- "type": "array"
- },
- "gtin": {
- "description": "Global Trade Item Number (GTIN) of the item.",
- "type": "string"
- },
- "id": {
- "description": "The REST ID of the product.",
- "type": "string"
- },
- "imageLink": {
- "description": "URL of an image of the item.",
- "type": "string"
- },
- "itemGroupId": {
- "description": "Shared identifier for all variants of the same product.",
- "type": "string"
- },
- "mpn": {
- "description": "Manufacturer Part Number (MPN) of the item.",
- "type": "string"
- },
- "offerId": {
- "description": "An identifier of the item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "shownImage": {
- "description": "URL to the cached image shown to the user when order was placed.",
- "type": "string"
- },
- "targetCountry": {
- "description": "The CLDR territory // code of the target country of the product.",
- "type": "string"
- },
- "title": {
- "description": "The title of the product.",
- "type": "string"
- },
- "variantAttributes": {
- "description": "Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderLineItemProductFee": {
- "id": "OrderLineItemProductFee",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "Amount of the fee."
- },
- "name": {
- "description": "Name of the fee.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItemProductVariantAttribute": {
- "id": "OrderLineItemProductVariantAttribute",
- "properties": {
- "dimension": {
- "description": "The dimension of the variant.",
- "type": "string"
- },
- "value": {
- "description": "The value for the dimension.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItemReturnInfo": {
- "id": "OrderLineItemReturnInfo",
- "properties": {
- "daysToReturn": {
- "description": "Required. How many days later the item can be returned.",
- "format": "int32",
- "type": "integer"
- },
- "isReturnable": {
- "description": "Required. Whether the item is returnable.",
- "type": "boolean"
- },
- "policyUrl": {
- "description": "Required. URL of the item return policy.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItemShippingDetails": {
- "id": "OrderLineItemShippingDetails",
- "properties": {
- "deliverByDate": {
- "description": "Required. The delivery by date, in ISO 8601 format.",
- "type": "string"
- },
- "method": {
- "$ref": "OrderLineItemShippingDetailsMethod",
- "description": "Required. Details of the shipping method."
- },
- "pickupPromiseInMinutes": {
- "description": "The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.",
- "format": "uint32",
- "type": "integer"
- },
- "shipByDate": {
- "description": "Required. The ship by date, in ISO 8601 format.",
- "type": "string"
- },
- "type": {
- "description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderLineItemShippingDetailsMethod": {
- "id": "OrderLineItemShippingDetailsMethod",
- "properties": {
- "carrier": {
- "description": "The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.",
- "type": "string"
- },
- "maxDaysInTransit": {
- "description": "Required. Maximum transit time.",
- "format": "uint32",
- "type": "integer"
- },
- "methodName": {
- "description": "Required. The name of the shipping method.",
- "type": "string"
- },
- "minDaysInTransit": {
- "description": "Required. Minimum transit time.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrderMerchantProvidedAnnotation": {
- "id": "OrderMerchantProvidedAnnotation",
- "properties": {
- "key": {
- "description": "Key for additional merchant provided (as key-value pairs) annotation about the line item.",
- "type": "string"
- },
- "value": {
- "description": "Value for additional merchant provided (as key-value pairs) annotation about the line item.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderOrderAnnotation": {
- "id": "OrderOrderAnnotation",
- "properties": {
- "key": {
- "description": "Key for additional google provided (as key-value pairs) annotation.",
- "type": "string"
- },
- "value": {
- "description": "Value for additional google provided (as key-value pairs) annotation.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderPickupDetails": {
- "id": "OrderPickupDetails",
- "properties": {
- "address": {
- "$ref": "OrderAddress",
- "description": "Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location."
- },
- "collectors": {
- "description": "Collectors authorized to pick up shipment from the pickup location.",
- "items": {
- "$ref": "OrderPickupDetailsCollector"
- },
- "type": "array"
- },
- "locationId": {
- "description": "ID of the pickup location.",
- "type": "string"
- },
- "pickupType": {
- "description": "The pickup type of this order. Acceptable values are: - \"`merchantStore`\" - \"`merchantStoreCurbside`\" - \"`merchantStoreLocker`\" - \"`thirdPartyPickupPoint`\" - \"`thirdPartyLocker`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderPickupDetailsCollector": {
- "id": "OrderPickupDetailsCollector",
- "properties": {
- "name": {
- "description": "Name of the person picking up the shipment.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Phone number of the person picking up the shipment.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderPromotion": {
- "id": "OrderPromotion",
- "properties": {
- "applicableItems": {
- "description": "Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.",
- "items": {
- "$ref": "OrderPromotionItem"
- },
- "type": "array"
- },
- "appliedItems": {
- "description": "Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.",
- "items": {
- "$ref": "OrderPromotionItem"
- },
- "type": "array"
- },
- "endTime": {
- "description": "Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".",
- "type": "string"
- },
- "funder": {
- "description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - \"`google`\" - \"`merchant`\" ",
- "type": "string"
- },
- "merchantPromotionId": {
- "description": "Required. This field is used to identify promotions within merchants' own systems.",
- "type": "string"
- },
- "priceValue": {
- "$ref": "Price",
- "description": "Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order."
- },
- "shortTitle": {
- "description": "A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.",
- "type": "string"
- },
- "startTime": {
- "description": "Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".",
- "type": "string"
- },
- "subtype": {
- "description": "Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`. Acceptable values are: - \"`buyMGetMoneyOff`\" - \"`buyMGetNMoneyOff`\" - \"`buyMGetNPercentOff`\" - \"`buyMGetPercentOff`\" - \"`freeGift`\" - \"`freeGiftWithItemId`\" - \"`freeGiftWithValue`\" - \"`freeShippingOvernight`\" - \"`freeShippingStandard`\" - \"`freeShippingTwoDay`\" - \"`moneyOff`\" - \"`percentOff`\" - \"`rewardPoints`\" - \"`salePrice`\" ",
- "type": "string"
- },
- "taxValue": {
- "$ref": "Price",
- "description": "Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`."
- },
- "title": {
- "description": "Required. The title of the promotion.",
- "type": "string"
- },
- "type": {
- "description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - \"`product`\" - \"`shipping`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderPromotionItem": {
- "id": "OrderPromotionItem",
- "properties": {
- "lineItemId": {
- "description": "The line item ID of a product. Do not provide for `orders.createtestorder`.",
- "type": "string"
- },
- "offerId": {
- "description": "Required. Offer ID of a product. Only for `orders.createtestorder`.",
- "type": "string"
- },
- "productId": {
- "description": "`orders.createtestorder`.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity of the associated product. Do not provide for `orders.createtestorder`.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrderRefund": {
- "id": "OrderRefund",
- "properties": {
- "actor": {
- "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
- "type": "string"
- },
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "creationDate": {
- "description": "Date on which the item has been created, in ISO 8601 format.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderReportDisbursement": {
- "description": "Order disbursement. All methods require the payment analyst role.",
- "id": "OrderReportDisbursement",
- "properties": {
- "disbursementAmount": {
- "$ref": "Price",
- "description": "The disbursement amount."
- },
- "disbursementCreationDate": {
- "description": "The disbursement date, in ISO 8601 format.",
- "type": "string"
- },
- "disbursementDate": {
- "description": "The date the disbursement was initiated, in ISO 8601 format.",
- "type": "string"
- },
- "disbursementId": {
- "description": "The ID of the disbursement.",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderReportTransaction": {
- "id": "OrderReportTransaction",
- "properties": {
- "disbursementAmount": {
- "$ref": "Price",
- "description": "The disbursement amount."
- },
- "disbursementCreationDate": {
- "description": "The date the disbursement was created, in ISO 8601 format.",
- "type": "string"
- },
- "disbursementDate": {
- "description": "The date the disbursement was initiated, in ISO 8601 format.",
- "type": "string"
- },
- "disbursementId": {
- "description": "The ID of the disbursement.",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "merchantOrderId": {
- "description": "Merchant-provided ID of the order.",
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "type": "string"
- },
- "productAmount": {
- "$ref": "ProductAmount",
- "description": "Total amount for the items."
- },
- "transactionDate": {
- "description": "The date of the transaction, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderReturn": {
- "id": "OrderReturn",
- "properties": {
- "actor": {
- "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
- "type": "string"
- },
- "creationDate": {
- "description": "Date on which the item has been created, in ISO 8601 format.",
- "type": "string"
- },
- "quantity": {
- "description": "Quantity that is returned.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderShipment": {
- "id": "OrderShipment",
- "properties": {
- "carrier": {
- "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Priv\u00e9) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ",
- "type": "string"
- },
- "creationDate": {
- "description": "Date on which the shipment has been created, in ISO 8601 format.",
- "type": "string"
- },
- "deliveryDate": {
- "description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`",
- "type": "string"
- },
- "id": {
- "description": "The ID of the shipment.",
- "type": "string"
- },
- "lineItems": {
- "description": "The line items that are shipped.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- },
- "type": "array"
- },
- "scheduledDeliveryDetails": {
- "$ref": "OrderShipmentScheduledDeliveryDetails",
- "description": "Delivery details of the shipment if scheduling is needed."
- },
- "shipmentGroupId": {
- "description": "The shipment group ID of the shipment. This is set in shiplineitems request.",
- "type": "string"
- },
- "status": {
- "description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ",
- "type": "string"
- },
- "trackingId": {
- "description": "The tracking ID for the shipment.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderShipmentLineItemShipment": {
- "id": "OrderShipmentLineItemShipment",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity that is shipped.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrderShipmentScheduledDeliveryDetails": {
- "id": "OrderShipmentScheduledDeliveryDetails",
- "properties": {
- "carrierPhoneNumber": {
- "description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., \"+41 44 668 1800\").",
- "type": "string"
- },
- "scheduledDate": {
- "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignal": {
- "description": "Represents a merchant trade from which signals are extracted, e.g. shipping.",
- "id": "OrderTrackingSignal",
- "properties": {
- "customerShippingFee": {
- "$ref": "PriceAmount",
- "description": "The shipping fee of the order; this value should be set to zero in the case of free shipping."
- },
- "deliveryPostalCode": {
- "description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
- "type": "string"
- },
- "deliveryRegionCode": {
- "description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.",
- "type": "string"
- },
- "lineItems": {
- "description": "Information about line items in the order.",
- "items": {
- "$ref": "OrderTrackingSignalLineItemDetails"
- },
- "type": "array"
- },
- "merchantId": {
- "description": "The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).",
- "format": "int64",
- "type": "string"
- },
- "orderCreatedTime": {
- "$ref": "DateTime",
- "description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available."
- },
- "orderId": {
- "description": "Required. The ID of the order on the merchant side.",
- "type": "string"
- },
- "orderTrackingSignalId": {
- "description": "Output only. The ID that uniquely identifies this order tracking signal.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "shipmentLineItemMapping": {
- "description": "The mapping of the line items to the shipment information.",
- "items": {
- "$ref": "OrderTrackingSignalShipmentLineItemMapping"
- },
- "type": "array"
- },
- "shippingInfo": {
- "description": "The shipping information for the order.",
- "items": {
- "$ref": "OrderTrackingSignalShippingInfo"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalLineItemDetails": {
- "description": "The line items of the order.",
- "id": "OrderTrackingSignalLineItemDetails",
- "properties": {
- "gtin": {
- "description": "The Global Trade Item Number.",
- "type": "string"
- },
- "lineItemId": {
- "description": "Required. The ID for this line item.",
- "type": "string"
- },
- "mpn": {
- "description": "The manufacturer part number.",
- "type": "string"
- },
- "productId": {
- "description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.",
- "type": "string"
- },
- "quantity": {
- "description": "Required. The quantity of the line item in the order.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalShipmentLineItemMapping": {
- "description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.",
- "id": "OrderTrackingSignalShipmentLineItemMapping",
- "properties": {
- "lineItemId": {
- "description": "Required. The line item ID.",
- "type": "string"
- },
- "quantity": {
- "description": "Required. The line item quantity in the shipment.",
- "format": "int64",
- "type": "string"
- },
- "shipmentId": {
- "description": "Required. The shipment ID.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalShippingInfo": {
- "description": "The shipping information for the order.",
- "id": "OrderTrackingSignalShippingInfo",
- "properties": {
- "actualDeliveryTime": {
- "$ref": "DateTime",
- "description": "The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "carrierName": {
- "description": "The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
- "type": "string"
- },
- "carrierServiceName": {
- "description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.",
- "type": "string"
- },
- "earliestDeliveryPromiseTime": {
- "$ref": "DateTime",
- "description": "The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "latestDeliveryPromiseTime": {
- "$ref": "DateTime",
- "description": "The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "originPostalCode": {
- "description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
- "type": "string"
- },
- "originRegionCode": {
- "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.",
- "type": "string"
- },
- "shipmentId": {
- "description": "Required. The shipment ID.",
- "type": "string"
- },
- "shippedTime": {
- "$ref": "DateTime",
- "description": "The time when the shipment was shipped. Include the year and timezone string, if available."
- },
- "shippingStatus": {
- "description": "The status of the shipment.",
- "enum": [
- "SHIPPING_STATE_UNSPECIFIED",
- "SHIPPED",
- "DELIVERED"
- ],
- "enumDescriptions": [
- "The shipping status is not known to merchant.",
- "All items are shipped.",
- "The shipment is already delivered."
- ],
- "type": "string"
- },
- "trackingId": {
- "description": "The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCreateChargeInvoiceRequest": {
- "id": "OrderinvoicesCreateChargeInvoiceRequest",
- "properties": {
- "invoiceId": {
- "description": "[required] The ID of the invoice.",
- "type": "string"
- },
- "invoiceSummary": {
- "$ref": "InvoiceSummary",
- "description": "[required] Invoice summary."
- },
- "lineItemInvoices": {
- "description": "[required] Invoice details per line item.",
- "items": {
- "$ref": "ShipmentInvoiceLineItemInvoice"
- },
- "type": "array"
- },
- "operationId": {
- "description": "[required] The ID of the operation, unique across all operations for a given order.",
- "type": "string"
- },
- "shipmentGroupId": {
- "description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCreateChargeInvoiceResponse": {
- "id": "OrderinvoicesCreateChargeInvoiceResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateChargeInvoiceResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCreateRefundInvoiceRequest": {
- "id": "OrderinvoicesCreateRefundInvoiceRequest",
- "properties": {
- "invoiceId": {
- "description": "[required] The ID of the invoice.",
- "type": "string"
- },
- "operationId": {
- "description": "[required] The ID of the operation, unique across all operations for a given order.",
- "type": "string"
- },
- "refundOnlyOption": {
- "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
- "description": "Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
- },
- "returnOption": {
- "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
- "description": "Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
- },
- "shipmentInvoices": {
- "description": "Invoice details for different shipment groups.",
- "items": {
- "$ref": "ShipmentInvoice"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCreateRefundInvoiceResponse": {
- "id": "OrderinvoicesCreateRefundInvoiceResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateRefundInvoiceResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption": {
- "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
- "properties": {
- "description": {
- "description": "Optional description of the refund reason.",
- "type": "string"
- },
- "reason": {
- "description": "[required] Reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption": {
- "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
- "properties": {
- "description": {
- "description": "Optional description of the return reason.",
- "type": "string"
- },
- "reason": {
- "description": "[required] Reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreportsListDisbursementsResponse": {
- "id": "OrderreportsListDisbursementsResponse",
- "properties": {
- "disbursements": {
- "description": "The list of disbursements.",
- "items": {
- "$ref": "OrderReportDisbursement"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of disbursements.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreportsListTransactionsResponse": {
- "id": "OrderreportsListTransactionsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of transactions.",
- "type": "string"
- },
- "transactions": {
- "description": "The list of transactions.",
- "items": {
- "$ref": "OrderReportTransaction"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderreturnsAcknowledgeRequest": {
- "id": "OrderreturnsAcknowledgeRequest",
- "properties": {
- "operationId": {
- "description": "[required] The ID of the operation, unique across all operations for a given order return.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsAcknowledgeResponse": {
- "id": "OrderreturnsAcknowledgeResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsAcknowledgeResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsCreateOrderReturnRequest": {
- "id": "OrderreturnsCreateOrderReturnRequest",
- "properties": {
- "lineItems": {
- "description": "The list of line items to return.",
- "items": {
- "$ref": "OrderreturnsLineItem"
- },
- "type": "array"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the order.",
- "type": "string"
- },
- "returnMethodType": {
- "description": "The way of the package being returned.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsCreateOrderReturnResponse": {
- "id": "OrderreturnsCreateOrderReturnResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsCreateOrderReturnResponse\".",
- "type": "string"
- },
- "orderReturn": {
- "$ref": "MerchantOrderReturn",
- "description": "Created order return."
- }
- },
- "type": "object"
- },
- "OrderreturnsLineItem": {
- "id": "OrderreturnsLineItem",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item. This value is assigned by Google when an order is created.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity of this line item.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrderreturnsListResponse": {
- "id": "OrderreturnsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of returns.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "MerchantOrderReturn"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderreturnsPartialRefund": {
- "id": "OrderreturnsPartialRefund",
- "properties": {
- "priceAmount": {
- "$ref": "Price",
- "description": "The pre-tax or post-tax amount to be refunded, depending on the location of the order."
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "Tax amount to be refunded. Note: This has different meaning depending on the location of the order."
- }
- },
- "type": "object"
- },
- "OrderreturnsProcessRequest": {
- "id": "OrderreturnsProcessRequest",
- "properties": {
- "fullChargeReturnShippingCost": {
- "description": "Option to charge the customer return shipping cost.",
- "type": "boolean"
- },
- "operationId": {
- "description": "[required] The ID of the operation, unique across all operations for a given order return.",
- "type": "string"
- },
- "refundShippingFee": {
- "$ref": "OrderreturnsRefundOperation",
- "description": "Refunds for original shipping fee."
- },
- "returnItems": {
- "description": "The list of items to return.",
- "items": {
- "$ref": "OrderreturnsReturnItem"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderreturnsProcessResponse": {
- "id": "OrderreturnsProcessResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsProcessResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsRefundOperation": {
- "id": "OrderreturnsRefundOperation",
- "properties": {
- "fullRefund": {
- "description": "If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP.",
- "type": "boolean"
- },
- "partialRefund": {
- "$ref": "OrderreturnsPartialRefund",
- "description": "If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer."
- },
- "paymentType": {
- "description": "The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- },
- "returnRefundReason": {
- "description": "Code of the refund reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsRejectOperation": {
- "id": "OrderreturnsRejectOperation",
- "properties": {
- "reason": {
- "description": "The reason for the return.",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderreturnsReturnItem": {
- "id": "OrderreturnsReturnItem",
- "properties": {
- "refund": {
- "$ref": "OrderreturnsRefundOperation",
- "description": "Refunds the item."
- },
- "reject": {
- "$ref": "OrderreturnsRejectOperation",
- "description": "Rejects the item."
- },
- "returnItemId": {
- "description": "Unit level ID for the return item. Different units of the same product will have different IDs.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersAcknowledgeRequest": {
- "id": "OrdersAcknowledgeRequest",
- "properties": {
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersAcknowledgeResponse": {
- "id": "OrdersAcknowledgeResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersAdvanceTestOrderResponse": {
- "id": "OrdersAdvanceTestOrderResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelLineItemRequest": {
- "id": "OrdersCancelLineItemRequest",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item to cancel. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity to cancel.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelLineItemResponse": {
- "id": "OrdersCancelLineItemResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelRequest": {
- "id": "OrdersCancelRequest",
- "properties": {
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelResponse": {
- "id": "OrdersCancelResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelTestOrderByCustomerRequest": {
- "id": "OrdersCancelTestOrderByCustomerRequest",
- "properties": {
- "reason": {
- "description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCancelTestOrderByCustomerResponse": {
- "id": "OrdersCancelTestOrderByCustomerResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCreateTestOrderRequest": {
- "id": "OrdersCreateTestOrderRequest",
- "properties": {
- "country": {
- "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.",
- "type": "string"
- },
- "templateName": {
- "description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ",
- "type": "string"
- },
- "testOrder": {
- "$ref": "TestOrder",
- "description": "The test order to create."
- }
- },
- "type": "object"
- },
- "OrdersCreateTestOrderResponse": {
- "id": "OrdersCreateTestOrderResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
- "type": "string"
- },
- "orderId": {
- "description": "The ID of the newly created test order.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCreateTestReturnRequest": {
- "id": "OrdersCreateTestReturnRequest",
- "properties": {
- "items": {
- "description": "Returned items.",
- "items": {
- "$ref": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrdersCreateTestReturnResponse": {
- "id": "OrdersCreateTestReturnResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\".",
- "type": "string"
- },
- "returnId": {
- "description": "The ID of the newly created test order return.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem": {
- "id": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item to return.",
- "type": "string"
- },
- "quantity": {
- "description": "Quantity that is returned.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrdersCustomBatchRequestEntryRefundItemItem": {
- "id": "OrdersCustomBatchRequestEntryRefundItemItem",
- "properties": {
- "amount": {
- "$ref": "MonetaryAmount",
- "description": "The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer."
- },
- "fullRefund": {
- "description": "If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored.",
- "type": "boolean"
- },
- "lineItemId": {
- "description": "The ID of the line item. Either lineItemId or productId is required.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The number of products that are refunded.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OrdersCustomBatchRequestEntryRefundItemShipping": {
- "id": "OrdersCustomBatchRequestEntryRefundItemShipping",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount."
- },
- "fullRefund": {
- "description": "If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo": {
- "id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo",
- "properties": {
- "carrier": {
- "description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
- "type": "string"
- },
- "shipmentId": {
- "description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.",
- "type": "string"
- },
- "trackingId": {
- "description": "The tracking ID for the shipment.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails": {
- "description": "ScheduledDeliveryDetails used to update the scheduled delivery order.",
- "id": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails",
- "properties": {
- "carrierPhoneNumber": {
- "description": "The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in",
- "type": "string"
- },
- "scheduledDate": {
- "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersGetByMerchantOrderIdResponse": {
- "id": "OrdersGetByMerchantOrderIdResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".",
- "type": "string"
- },
- "order": {
- "$ref": "Order",
- "description": "The requested order."
- }
- },
- "type": "object"
- },
- "OrdersGetTestOrderTemplateResponse": {
- "id": "OrdersGetTestOrderTemplateResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".",
- "type": "string"
- },
- "template": {
- "$ref": "TestOrder",
- "description": "The requested test order template."
- }
- },
- "type": "object"
- },
- "OrdersInStoreRefundLineItemRequest": {
- "id": "OrdersInStoreRefundLineItemRequest",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item to return. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "priceAmount": {
- "$ref": "Price",
- "description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required."
- },
- "productId": {
- "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity to return and refund.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "The amount of tax to be refunded. Required."
- }
- },
- "type": "object"
- },
- "OrdersInStoreRefundLineItemResponse": {
- "id": "OrdersInStoreRefundLineItemResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersListResponse": {
- "id": "OrdersListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of orders.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Order"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrdersRefundItemRequest": {
- "id": "OrdersRefundItemRequest",
- "properties": {
- "items": {
- "description": "The items that are refunded. Either Item or Shipping must be provided in the request.",
- "items": {
- "$ref": "OrdersCustomBatchRequestEntryRefundItemItem"
- },
- "type": "array"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the refund. Acceptable values are: - \"`shippingCostAdjustment`\" - \"`priceAdjustment`\" - \"`taxAdjustment`\" - \"`feeAdjustment`\" - \"`courtesyAdjustment`\" - \"`adjustment`\" - \"`customerCancelled`\" - \"`noInventory`\" - \"`productNotAsDescribed`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" - \"`lateShipmentCredit`\" - \"`deliveredLateByCarrier`\" - \"`productArrivedDamaged`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- },
- "shipping": {
- "$ref": "OrdersCustomBatchRequestEntryRefundItemShipping",
- "description": "The refund on shipping. Optional, but either Item or Shipping must be provided in the request."
- }
- },
- "type": "object"
- },
- "OrdersRefundItemResponse": {
- "id": "OrdersRefundItemResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundItemResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersRefundOrderRequest": {
- "id": "OrdersRefundOrderRequest",
- "properties": {
- "amount": {
- "$ref": "MonetaryAmount",
- "description": "The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount."
- },
- "fullRefund": {
- "description": "If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored.",
- "type": "boolean"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the refund. Acceptable values are: - \"`courtesyAdjustment`\" - \"`other`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersRefundOrderResponse": {
- "id": "OrdersRefundOrderResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundOrderResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersRejectReturnLineItemRequest": {
- "id": "OrdersRejectReturnLineItemRequest",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item to return. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity to return and refund.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersRejectReturnLineItemResponse": {
- "id": "OrdersRejectReturnLineItemResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRejectReturnLineItemResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersReturnRefundLineItemRequest": {
- "id": "OrdersReturnRefundLineItemRequest",
- "properties": {
- "lineItemId": {
- "description": "The ID of the line item to return. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "priceAmount": {
- "$ref": "Price",
- "description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed."
- },
- "productId": {
- "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity to return and refund. Quantity is required.",
- "format": "uint32",
- "type": "integer"
- },
- "reason": {
- "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- },
- "reasonText": {
- "description": "The explanation of the reason.",
- "type": "string"
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided."
- }
- },
- "type": "object"
- },
- "OrdersReturnRefundLineItemResponse": {
- "id": "OrdersReturnRefundLineItemResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnRefundLineItemResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersSetLineItemMetadataRequest": {
- "id": "OrdersSetLineItemMetadataRequest",
- "properties": {
- "annotations": {
- "items": {
- "$ref": "OrderMerchantProvidedAnnotation"
- },
- "type": "array"
- },
- "lineItemId": {
- "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersSetLineItemMetadataResponse": {
- "id": "OrdersSetLineItemMetadataResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersShipLineItemsRequest": {
- "id": "OrdersShipLineItemsRequest",
- "properties": {
- "lineItems": {
- "description": "Line items to ship.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- },
- "type": "array"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "shipmentGroupId": {
- "description": "ID of the shipment group. Required for orders that use the orderinvoices service.",
- "type": "string"
- },
- "shipmentInfos": {
- "description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
- "items": {
- "$ref": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrdersShipLineItemsResponse": {
- "id": "OrdersShipLineItemsResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateLineItemShippingDetailsRequest": {
- "id": "OrdersUpdateLineItemShippingDetailsRequest",
- "properties": {
- "deliverByDate": {
- "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
- "type": "string"
- },
- "lineItemId": {
- "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
- "type": "string"
- },
- "shipByDate": {
- "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateLineItemShippingDetailsResponse": {
- "id": "OrdersUpdateLineItemShippingDetailsResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateMerchantOrderIdRequest": {
- "id": "OrdersUpdateMerchantOrderIdRequest",
- "properties": {
- "merchantOrderId": {
- "description": "The merchant order id to be assigned to the order. Must be unique per merchant.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateMerchantOrderIdResponse": {
- "id": "OrdersUpdateMerchantOrderIdResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateShipmentRequest": {
- "id": "OrdersUpdateShipmentRequest",
- "properties": {
- "carrier": {
- "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
- "type": "string"
- },
- "deliveryDate": {
- "description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.",
- "type": "string"
- },
- "lastPickupDate": {
- "description": "Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and `status` is `ready for pickup`.",
- "type": "string"
- },
- "operationId": {
- "description": "The ID of the operation. Unique across all operations for a given order.",
- "type": "string"
- },
- "readyPickupDate": {
- "description": "Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if `status` is `ready for pickup`.",
- "type": "string"
- },
- "scheduledDeliveryDetails": {
- "$ref": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails",
- "description": "Delivery details of the shipment if scheduling is needed."
- },
- "shipmentId": {
- "description": "The ID of the shipment.",
- "type": "string"
- },
- "status": {
- "description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" ",
- "type": "string"
- },
- "trackingId": {
- "description": "The tracking ID for the shipment. Not updated if missing.",
- "type": "string"
- },
- "undeliveredDate": {
- "description": "Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if `status` is `undeliverable`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrdersUpdateShipmentResponse": {
- "id": "OrdersUpdateShipmentResponse",
- "properties": {
- "executionStatus": {
- "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PickupCarrierService": {
- "id": "PickupCarrierService",
- "properties": {
- "carrierName": {
- "description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required.",
- "type": "string"
- },
- "serviceName": {
- "description": "The name of the pickup service (e.g., `\"Access point\"`). Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PickupServicesPickupService": {
- "id": "PickupServicesPickupService",
- "properties": {
- "carrierName": {
- "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
- "type": "string"
- },
- "country": {
- "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
- "type": "string"
- },
- "serviceName": {
- "description": "The name of the pickup service (e.g., `\"Access point\"`). Always present.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchRequest": {
- "id": "PosCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "PosCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosCustomBatchRequestEntry": {
- "id": "PosCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "inventory": {
- "$ref": "PosInventory",
- "description": "The inventory to submit. This should be set only if the method is `inventory`."
- },
- "merchantId": {
- "description": "The ID of the POS data provider.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" ",
- "type": "string"
- },
- "sale": {
- "$ref": "PosSale",
- "description": "The sale information to submit. This should be set only if the method is `sale`."
- },
- "store": {
- "$ref": "PosStore",
- "description": "The store information to submit. This should be set only if the method is `insert`."
- },
- "storeCode": {
- "description": "The store code. This should be set only if the method is `delete` or `get`.",
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the account for which to get/submit data.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchResponse": {
- "id": "PosCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "PosCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchResponseEntry": {
- "id": "PosCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "inventory": {
- "$ref": "PosInventory",
- "description": "The updated inventory information."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "sale": {
- "$ref": "PosSale",
- "description": "The updated sale information."
- },
- "store": {
- "$ref": "PosStore",
- "description": "The retrieved or updated store information."
- }
- },
- "type": "object"
- },
- "PosDataProviders": {
- "id": "PosDataProviders",
- "properties": {
- "country": {
- "description": "Country code.",
- "type": "string"
- },
- "posDataProviders": {
- "description": "A list of POS data providers.",
- "items": {
- "$ref": "PosDataProvidersPosDataProvider"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosDataProvidersPosDataProvider": {
- "id": "PosDataProvidersPosDataProvider",
- "properties": {
- "displayName": {
- "description": "The display name of Pos data Provider.",
- "type": "string"
- },
- "fullName": {
- "description": "The full name of this POS data Provider.",
- "type": "string"
- },
- "providerId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventory": {
- "description": "The absolute quantity of an item available at the given store.",
- "id": "PosInventory",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventoryRequest": {
- "id": "PosInventoryRequest",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventoryResponse": {
- "id": "PosInventoryResponse",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\".",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosListResponse": {
- "id": "PosListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\".",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "PosStore"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosSale": {
- "description": "The change of the available quantity of an item at the given store.",
- "id": "PosSale",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\"",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosSaleRequest": {
- "id": "PosSaleRequest",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosSaleResponse": {
- "id": "PosSaleResponse",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\".",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosStore": {
- "description": "Store resource.",
- "id": "PosStore",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\"",
- "type": "string"
- },
- "storeAddress": {
- "description": "Required. The street address of the store.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. A store identifier that is unique for the given merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PostalCodeGroup": {
- "id": "PostalCodeGroup",
- "properties": {
- "country": {
- "description": "The CLDR territory code of the country the postal code group applies to. Required.",
- "type": "string"
- },
- "name": {
- "description": "The name of the postal code group, referred to in headers. Required.",
- "type": "string"
- },
- "postalCodeRanges": {
- "description": "A range of postal codes. Required.",
- "items": {
- "$ref": "PostalCodeRange"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PostalCodeRange": {
- "id": "PostalCodeRange",
- "properties": {
- "postalCodeRangeBegin": {
- "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `\"94108\"`, `\"9410*\"`, `\"9*\"`. Required.",
- "type": "string"
- },
- "postalCodeRangeEnd": {
- "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Price": {
- "id": "Price",
- "properties": {
- "currency": {
- "description": "The currency of the price.",
- "type": "string"
- },
- "value": {
- "description": "The price represented as a number.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PriceAmount": {
- "description": "The price represented as a number and currency.",
- "id": "PriceAmount",
- "properties": {
- "currency": {
- "description": "The currency of the price.",
- "type": "string"
- },
- "value": {
- "description": "The price represented as a number.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Product": {
- "description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.",
- "id": "Product",
- "properties": {
- "additionalImageLinks": {
- "description": "Additional URLs of images of the item.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "adsGrouping": {
- "description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.",
- "type": "string"
- },
- "adsLabels": {
- "description": "Similar to ads_grouping, but only works on CPC.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "adsRedirect": {
- "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.",
- "type": "string"
- },
- "adult": {
- "description": "Should be set to true if the item is targeted towards adults.",
- "type": "boolean"
- },
- "ageGroup": {
- "description": "Target age group of the item.",
- "type": "string"
- },
- "availability": {
- "description": "Availability status of the item.",
- "type": "string"
- },
- "availabilityDate": {
- "description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format.",
- "type": "string"
- },
- "brand": {
- "description": "Brand of the item.",
- "type": "string"
- },
- "canonicalLink": {
- "description": "URL for the canonical version of your item's landing page.",
- "type": "string"
- },
- "channel": {
- "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ",
- "type": "string"
- },
- "color": {
- "description": "Color of the item.",
- "type": "string"
- },
- "condition": {
- "description": "Condition or state of the item.",
- "type": "string"
- },
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "costOfGoodsSold": {
- "$ref": "Price",
- "description": "Cost of goods sold. Used for gross profit reporting."
- },
- "customAttributes": {
- "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "customLabel0": {
- "description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel1": {
- "description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel2": {
- "description": "Custom label 2 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel3": {
- "description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel4": {
- "description": "Custom label 4 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "description": {
- "description": "Description of the item.",
- "type": "string"
- },
- "displayAdsId": {
- "description": "An identifier for an item for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsLink": {
- "description": "URL directly to your item's landing page for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsSimilarIds": {
- "description": "Advertiser-specified recommendations.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "displayAdsTitle": {
- "description": "Title of an item for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsValue": {
- "description": "Offer margin for dynamic remarketing campaigns.",
- "format": "double",
- "type": "number"
- },
- "energyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "excludedDestinations": {
- "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "expirationDate": {
- "description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.",
- "type": "string"
- },
- "gender": {
- "description": "Target gender of the item.",
- "type": "string"
- },
- "googleProductCategory": {
- "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number (GTIN) of the item.",
- "type": "string"
- },
- "id": {
- "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.",
- "type": "string"
- },
- "identifierExists": {
- "description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.",
- "type": "boolean"
- },
- "imageLink": {
- "description": "URL of an image of the item.",
- "type": "string"
- },
- "includedDestinations": {
- "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "installment": {
- "$ref": "Installment",
- "description": "Number and amount of installments to pay for an item."
- },
- "isBundle": {
- "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.",
- "type": "boolean"
- },
- "itemGroupId": {
- "description": "Shared identifier for all variants of the same product.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
- "type": "string"
- },
- "link": {
- "description": "URL directly linking to your item's page on your website.",
- "type": "string"
- },
- "loyaltyPoints": {
- "$ref": "LoyaltyPoints",
- "description": "Loyalty points that users receive after purchasing the item. Japan only."
- },
- "material": {
- "description": "The material of which the item is made.",
- "type": "string"
- },
- "maxEnergyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "maxHandlingTime": {
- "description": "Maximal product handling time (in business days).",
- "format": "int64",
- "type": "string"
- },
- "minEnergyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "minHandlingTime": {
- "description": "Minimal product handling time (in business days).",
- "format": "int64",
- "type": "string"
- },
- "mobileLink": {
- "description": "URL for the mobile-optimized version of your item's landing page.",
- "type": "string"
- },
- "mpn": {
- "description": "Manufacturer Part Number (MPN) of the item.",
- "type": "string"
- },
- "multipack": {
- "description": "The number of identical products in a merchant-defined multipack.",
- "format": "int64",
- "type": "string"
- },
- "offerId": {
- "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.",
- "type": "string"
- },
- "pattern": {
- "description": "The item's pattern (e.g. polka dots).",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "productDetails": {
- "description": "Technical specification or additional product details.",
- "items": {
- "$ref": "ProductProductDetail"
- },
- "type": "array"
- },
- "productHighlights": {
- "description": "Bullet points describing the most relevant highlights of a product.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "productTypes": {
- "description": "Categories of the item (formatted as in products data specification).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "promotionIds": {
- "description": "The unique ID of a promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "Advertised sale price of the item."
- },
- "salePriceEffectiveDate": {
- "description": "Date range during which the item is on sale (see products data specification ).",
- "type": "string"
- },
- "sellOnGoogleQuantity": {
- "description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
- "format": "int64",
- "type": "string"
- },
- "shipping": {
- "description": "Shipping rules.",
- "items": {
- "$ref": "ProductShipping"
- },
- "type": "array"
- },
- "shippingHeight": {
- "$ref": "ProductShippingDimension",
- "description": "Height of the item for shipping."
- },
- "shippingLabel": {
- "description": "The shipping label of the product, used to group product in account-level shipping rules.",
- "type": "string"
- },
- "shippingLength": {
- "$ref": "ProductShippingDimension",
- "description": "Length of the item for shipping."
- },
- "shippingWeight": {
- "$ref": "ProductShippingWeight",
- "description": "Weight of the item for shipping."
- },
- "shippingWidth": {
- "$ref": "ProductShippingDimension",
- "description": "Width of the item for shipping."
- },
- "shoppingAdsExcludedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "sizeSystem": {
- "description": "System in which the size is specified. Recommended for apparel items.",
- "type": "string"
- },
- "sizeType": {
- "description": "The cut of the item. Recommended for apparel items.",
- "type": "string"
- },
- "sizes": {
- "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "source": {
- "description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ",
- "type": "string"
- },
- "subscriptionCost": {
- "$ref": "ProductSubscriptionCost",
- "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract."
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "taxCategory": {
- "description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
- "type": "string"
- },
- "taxes": {
- "description": "Tax information.",
- "items": {
- "$ref": "ProductTax"
- },
- "type": "array"
- },
- "title": {
- "description": "Title of the item.",
- "type": "string"
- },
- "transitTimeLabel": {
- "description": "The transit time label of the product, used to group product in account-level transit time tables.",
- "type": "string"
- },
- "unitPricingBaseMeasure": {
- "$ref": "ProductUnitPricingBaseMeasure",
- "description": "The preference of the denominator of the unit price."
- },
- "unitPricingMeasure": {
- "$ref": "ProductUnitPricingMeasure",
- "description": "The measure and dimension of an item."
- }
- },
- "type": "object"
- },
- "ProductAmount": {
- "id": "ProductAmount",
- "properties": {
- "priceAmount": {
- "$ref": "Price",
- "description": "The pre-tax or post-tax price depending on the location of the order."
- },
- "remittedTaxAmount": {
- "$ref": "Price",
- "description": "Remitted tax value."
- },
- "taxAmount": {
- "$ref": "Price",
- "description": "Tax value."
- }
- },
- "type": "object"
- },
- "ProductProductDetail": {
- "id": "ProductProductDetail",
- "properties": {
- "attributeName": {
- "description": "The name of the product detail.",
- "type": "string"
- },
- "attributeValue": {
- "description": "The value of the product detail.",
- "type": "string"
- },
- "sectionName": {
- "description": "The section header used to group a set of product details.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductShipping": {
- "id": "ProductShipping",
- "properties": {
- "country": {
- "description": "The CLDR territory code of the country to which an item will ship.",
- "type": "string"
- },
- "locationGroupName": {
- "description": "The location where the shipping is applicable, represented by a location group name.",
- "type": "string"
- },
- "locationId": {
- "description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
- "format": "int64",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Fixed shipping price, represented as a number."
- },
- "region": {
- "description": "The geographic region to which a shipping rate applies.",
- "type": "string"
- },
- "service": {
- "description": "A free-form description of the service class or delivery speed.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductShippingDimension": {
- "id": "ProductShippingDimension",
- "properties": {
- "unit": {
- "description": "The unit of value.",
- "type": "string"
- },
- "value": {
- "description": "The dimension of the product used to calculate the shipping cost of the item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductShippingWeight": {
- "id": "ProductShippingWeight",
- "properties": {
- "unit": {
- "description": "The unit of value.",
- "type": "string"
- },
- "value": {
- "description": "The weight of the product used to calculate the shipping cost of the item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductStatus": {
- "description": "The status of a product, i.e., information about a product computed asynchronously.",
- "id": "ProductStatus",
- "properties": {
- "creationDate": {
- "description": "Date on which the item has been created, in ISO 8601 format.",
- "type": "string"
- },
- "destinationStatuses": {
- "description": "The intended destinations for the product.",
- "items": {
- "$ref": "ProductStatusDestinationStatus"
- },
- "type": "array"
- },
- "googleExpirationDate": {
- "description": "Date on which the item expires in Google Shopping, in ISO 8601 format.",
- "type": "string"
- },
- "itemLevelIssues": {
- "description": "A list of all issues associated with the product.",
- "items": {
- "$ref": "ProductStatusItemLevelIssue"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"",
- "type": "string"
- },
- "lastUpdateDate": {
- "description": "Date on which the item has been last updated, in ISO 8601 format.",
- "type": "string"
- },
- "link": {
- "description": "The link to the product.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which status is reported.",
- "type": "string"
- },
- "title": {
- "description": "The title of the product.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStatusDestinationStatus": {
- "id": "ProductStatusDestinationStatus",
- "properties": {
- "approvedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "destination": {
- "description": "The name of the destination",
- "type": "string"
- },
- "disapprovedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pendingCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "status": {
- "description": "Destination approval status in `targetCountry` of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStatusItemLevelIssue": {
- "id": "ProductStatusItemLevelIssue",
- "properties": {
- "applicableCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects serving of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductSubscriptionCost": {
- "id": "ProductSubscriptionCost",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount the buyer has to pay per subscription period."
- },
- "period": {
- "description": "The type of subscription period.",
- "type": "string"
- },
- "periodLength": {
- "description": "The number of subscription periods the buyer has to pay.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductTax": {
- "id": "ProductTax",
- "properties": {
- "country": {
- "description": "The country within which the item is taxed, specified as a CLDR territory code.",
- "type": "string"
- },
- "locationId": {
- "description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
- "format": "int64",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.",
- "type": "string"
- },
- "rate": {
- "description": "The percentage of tax rate that applies to the item price.",
- "format": "double",
- "type": "number"
- },
- "region": {
- "description": "The geographic region to which the tax rate applies.",
- "type": "string"
- },
- "taxShip": {
- "description": "Should be set to true if tax is charged on shipping.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ProductUnitPricingBaseMeasure": {
- "id": "ProductUnitPricingBaseMeasure",
- "properties": {
- "unit": {
- "description": "The unit of the denominator.",
- "type": "string"
- },
- "value": {
- "description": "The denominator of the unit price.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductUnitPricingMeasure": {
- "id": "ProductUnitPricingMeasure",
- "properties": {
- "unit": {
- "description": "The unit of the measure.",
- "type": "string"
- },
- "value": {
- "description": "The measure of an item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchRequest": {
- "id": "ProductsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch products request.",
- "id": "ProductsCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "feedId": {
- "description": "The Content API feed id.",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
- "type": "string"
- },
- "product": {
- "$ref": "Product",
- "description": "The product to insert. Only required if the method is `insert`."
- },
- "productId": {
- "description": "The ID of the product to get or delete. Only defined if the method is `get` or `delete`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchResponse": {
- "id": "ProductsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch products response.",
- "id": "ProductsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "product": {
- "$ref": "Product",
- "description": "The inserted product. Only defined if the method is `insert` and if the request was successful."
- }
- },
- "type": "object"
- },
- "ProductsListResponse": {
- "id": "ProductsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of products.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Product"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchRequest": {
- "id": "ProductstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch productstatuses request.",
- "id": "ProductstatusesCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "includeAttributes": {
- "type": "boolean"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product whose status to get.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchResponse": {
- "id": "ProductstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch productstatuses response.",
- "id": "ProductstatusesCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors, if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "productStatus": {
- "$ref": "ProductStatus",
- "description": "The requested product status. Only defined if the request was successful."
- }
- },
- "type": "object"
- },
- "ProductstatusesListResponse": {
- "id": "ProductstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of products statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ProductStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PubsubNotificationSettings": {
- "description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
- "id": "PubsubNotificationSettings",
- "properties": {
- "cloudTopicName": {
- "description": "Cloud pub/sub topic to which notifications are sent (read-only).",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\"",
- "type": "string"
- },
- "registeredEvents": {
- "description": "List of event types. Acceptable values are: - \"`orderPendingShipment`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RateGroup": {
- "id": "RateGroup",
- "properties": {
- "applicableShippingLabels": {
- "description": "A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "carrierRates": {
- "description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`.",
- "items": {
- "$ref": "CarrierRate"
- },
- "type": "array"
- },
- "mainTable": {
- "$ref": "Table",
- "description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set."
- },
- "name": {
- "description": "Name of the rate group. Optional. If set has to be unique within shipping service.",
- "type": "string"
- },
- "singleValue": {
- "$ref": "Value",
- "description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set."
- },
- "subtables": {
- "description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.",
- "items": {
- "$ref": "Table"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RefundReason": {
- "id": "RefundReason",
- "properties": {
- "description": {
- "description": "Description of the reason.",
- "type": "string"
- },
- "reasonCode": {
- "description": "Code of the refund reason. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Region": {
- "description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.",
- "id": "Region",
- "properties": {
- "displayName": {
- "description": "The display name of the region.",
- "type": "string"
- },
- "geotargetArea": {
- "$ref": "RegionGeoTargetArea",
- "description": "A list of geotargets that defines the region area."
- },
- "merchantId": {
- "description": "Output only. Immutable. Merchant that owns the region.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "postalCodeArea": {
- "$ref": "RegionPostalCodeArea",
- "description": "A list of postal codes that defines the region area."
- },
- "regionId": {
- "description": "Output only. Immutable. The ID uniquely identifying each region.",
- "readOnly": true,
- "type": "string"
- },
- "regionalInventoryEligible": {
- "description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.",
- "readOnly": true,
- "type": "boolean"
- },
- "shippingEligible": {
- "description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.",
- "readOnly": true,
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "RegionGeoTargetArea": {
- "description": "A list of geotargets that defines the region area.",
- "id": "RegionGeoTargetArea",
- "properties": {
- "geotargetCriteriaIds": {
- "description": "Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RegionPostalCodeArea": {
- "description": "A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.",
- "id": "RegionPostalCodeArea",
- "properties": {
- "postalCodes": {
- "description": "Required. A range of postal codes.",
- "items": {
- "$ref": "RegionPostalCodeAreaPostalCodeRange"
- },
- "type": "array"
- },
- "regionCode": {
- "description": "Required. CLDR territory code or the country the postal code group applies to.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionPostalCodeAreaPostalCodeRange": {
- "description": "A range of postal codes that defines the region area.",
- "id": "RegionPostalCodeAreaPostalCodeRange",
- "properties": {
- "begin": {
- "description": "Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: \"94108\", \"9410*\", \"9*\".",
- "type": "string"
- },
- "end": {
- "description": "Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalInventory": {
- "description": "Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.",
- "id": "RegionalInventory",
- "properties": {
- "availability": {
- "description": "The availability of the product.",
- "type": "string"
- },
- "customAttributes": {
- "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalInventory\".",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "The price of the product."
- },
- "regionId": {
- "description": "The ID uniquely identifying each region.",
- "type": "string"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
- },
- "salePriceEffectiveDate": {
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchRequest": {
- "id": "RegionalinventoryCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "RegionalinventoryCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch regional inventory request.",
- "id": "RegionalinventoryCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which to update price and availability.",
- "type": "string"
- },
- "regionalInventory": {
- "$ref": "RegionalInventory",
- "description": "Price and availability of the product."
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchResponse": {
- "id": "RegionalinventoryCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "RegionalinventoryCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch regional inventory response.",
- "id": "RegionalinventoryCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponseEntry\".",
- "type": "string"
- },
- "regionalInventory": {
- "$ref": "RegionalInventory",
- "description": "Price and availability of the product."
- }
- },
- "type": "object"
- },
- "ReportRow": {
- "description": "Result row returned from the search query.",
- "id": "ReportRow",
- "properties": {
- "metrics": {
- "$ref": "Metrics",
- "description": "Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query."
- },
- "segments": {
- "$ref": "Segments",
- "description": "Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query."
- }
- },
- "type": "object"
- },
- "RepricingProductReport": {
- "description": "Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.",
- "id": "RepricingProductReport",
- "properties": {
- "applicationCount": {
- "description": "Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period.",
- "format": "int64",
- "type": "string"
- },
- "buyboxWinningProductStats": {
- "$ref": "RepricingProductReportBuyboxWinningProductStats",
- "description": "Stats specific to buybox winning rules for product report."
- },
- "date": {
- "$ref": "Date",
- "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone."
- },
- "highWatermark": {
- "$ref": "PriceAmount",
- "description": "Maximum displayed price after repriced during this reporting period."
- },
- "inapplicabilityDetails": {
- "description": "List of all reasons the rule did not apply to the product during the specified reporting period.",
- "items": {
- "$ref": "InapplicabilityDetails"
- },
- "type": "array"
- },
- "lowWatermark": {
- "$ref": "PriceAmount",
- "description": "Minimum displayed price after repriced during this reporting period."
- },
- "orderItemCount": {
- "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
- "format": "int32",
- "type": "integer"
- },
- "ruleIds": {
- "description": "Ids of the Repricing rule for this report.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "totalGmv": {
- "$ref": "PriceAmount",
- "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed."
- },
- "type": {
- "description": "Type of the rule.",
- "enum": [
- "REPRICING_RULE_TYPE_UNSPECIFIED",
- "TYPE_STATS_BASED",
- "TYPE_COGS_BASED"
- ],
- "enumDescriptions": [
- "Unused.",
- "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
- "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingProductReportBuyboxWinningProductStats": {
- "description": "Stats specific to buybox winning rules for product report.",
- "id": "RepricingProductReportBuyboxWinningProductStats",
- "properties": {
- "buyboxWinsCount": {
- "description": "Number of times this product won the buybox with these rules during this time period.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RepricingRule": {
- "description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24",
- "id": "RepricingRule",
- "properties": {
- "cogsBasedRule": {
- "$ref": "RepricingRuleCostOfGoodsSaleRule",
- "description": "The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED."
- },
- "countryCode": {
- "description": "Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\").",
- "type": "string"
- },
- "effectiveTimePeriod": {
- "$ref": "RepricingRuleEffectiveTime",
- "description": "Required. Time period when the rule should take effect."
- },
- "eligibleOfferMatcher": {
- "$ref": "RepricingRuleEligibleOfferMatcher",
- "description": "Required. Match criteria for the eligible offers."
- },
- "languageCode": {
- "description": "Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.",
- "type": "string"
- },
- "merchantId": {
- "description": "Output only. Immutable. Merchant that owns the repricing rule.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "paused": {
- "description": "Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.",
- "type": "boolean"
- },
- "restriction": {
- "$ref": "RepricingRuleRestriction",
- "description": "Required. Restriction of the rule appliance."
- },
- "ruleId": {
- "description": "Output only. Immutable. The ID to uniquely identify each repricing rule.",
- "readOnly": true,
- "type": "string"
- },
- "statsBasedRule": {
- "$ref": "RepricingRuleStatsBasedRule",
- "description": "The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED."
- },
- "title": {
- "description": "The title for the rule.",
- "type": "string"
- },
- "type": {
- "description": "Required. Immutable. The type of the rule.",
- "enum": [
- "REPRICING_RULE_TYPE_UNSPECIFIED",
- "TYPE_STATS_BASED",
- "TYPE_COGS_BASED"
- ],
- "enumDescriptions": [
- "Unused.",
- "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
- "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingRuleCostOfGoodsSaleRule": {
- "description": "A repricing rule that changes the sale price based on cost of goods sale.",
- "id": "RepricingRuleCostOfGoodsSaleRule",
- "properties": {
- "percentageDelta": {
- "description": "The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.",
- "format": "int32",
- "type": "integer"
- },
- "priceDelta": {
- "description": "The price delta against the COGS. E.g. 2 means $2 more of the COGS.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingRuleEffectiveTime": {
- "id": "RepricingRuleEffectiveTime",
- "properties": {
- "fixedTimePeriods": {
- "description": "A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.",
- "items": {
- "$ref": "RepricingRuleEffectiveTimeFixedTimePeriod"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RepricingRuleEffectiveTimeFixedTimePeriod": {
- "description": "Definition of a fixed time period.",
- "id": "RepricingRuleEffectiveTimeFixedTimePeriod",
- "properties": {
- "endTime": {
- "description": "The end time (exclusive) of the period. It can only be hour granularity.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The start time (inclusive) of the period. It can only be hour granularity.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingRuleEligibleOfferMatcher": {
- "description": "Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.",
- "id": "RepricingRuleEligibleOfferMatcher",
- "properties": {
- "brandMatcher": {
- "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
- "description": "Filter by the brand."
- },
- "itemGroupIdMatcher": {
- "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
- "description": "Filter by the item group id."
- },
- "matcherOption": {
- "description": "Determines whether to use the custom matchers or the product feed attribute \"repricing_rule_id\" to specify offer-rule mapping.",
- "enum": [
- "MATCHER_OPTION_UNSPECIFIED",
- "MATCHER_OPTION_CUSTOM_FILTER",
- "MATCHER_OPTION_USE_FEED_ATTRIBUTE",
- "MATCHER_OPTION_ALL_PRODUCTS"
- ],
- "enumDescriptions": [
- "Unused.",
- "Use custom filters.",
- "Use repricing_rule_id feed attribute on the product resource to specify offer-rule mapping.",
- "Matching all products."
- ],
- "type": "string"
- },
- "offerIdMatcher": {
- "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
- "description": "Filter by the offer id."
- },
- "skipWhenOnPromotion": {
- "description": "When true, the rule won't be applied to offers with active promotions.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "RepricingRuleEligibleOfferMatcherStringMatcher": {
- "description": "Matcher by string attributes.",
- "id": "RepricingRuleEligibleOfferMatcherStringMatcher",
- "properties": {
- "strAttributes": {
- "description": "String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regex.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RepricingRuleReport": {
- "description": "Resource that represents a daily Repricing rule report. Next ID: 11",
- "id": "RepricingRuleReport",
- "properties": {
- "buyboxWinningRuleStats": {
- "$ref": "RepricingRuleReportBuyboxWinningRuleStats",
- "description": "Stats specific to buybox winning rules for rule report."
- },
- "date": {
- "$ref": "Date",
- "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone."
- },
- "impactedProducts": {
- "description": "List of product ids that are impacted by this rule during this reporting period. Out of stock products and products not searched for by customers are examples of non-impacted products.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "inapplicabilityDetails": {
- "description": "List of all reasons the rule did not apply to the inapplicable products during the specified reporting period.",
- "items": {
- "$ref": "InapplicabilityDetails"
- },
- "type": "array"
- },
- "inapplicableProducts": {
- "description": "List of product ids that are inapplicable to this rule during this reporting period. To get the inapplicable reason for a specific product, see RepricingProductReport.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "orderItemCount": {
- "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
- "format": "int32",
- "type": "integer"
- },
- "ruleId": {
- "description": "Id of the Repricing rule for this report.",
- "type": "string"
- },
- "totalGmv": {
- "$ref": "PriceAmount",
- "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed."
- },
- "type": {
- "description": "Type of the rule.",
- "enum": [
- "REPRICING_RULE_TYPE_UNSPECIFIED",
- "TYPE_STATS_BASED",
- "TYPE_COGS_BASED"
- ],
- "enumDescriptions": [
- "Unused.",
- "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
- "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingRuleReportBuyboxWinningRuleStats": {
- "description": "Stats specific to buybox winning rules for rule report.",
- "id": "RepricingRuleReportBuyboxWinningRuleStats",
- "properties": {
- "buyboxWonProductCount": {
- "description": "Number of unique products that won the buybox with this rule during this period of time.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RepricingRuleRestriction": {
- "description": "Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is \"-10\" and the floor.price_delta is \"-12\", the offer price will only be lowered $5 (10% lower than the original offer price).",
- "id": "RepricingRuleRestriction",
- "properties": {
- "floor": {
- "$ref": "RepricingRuleRestrictionBoundary",
- "description": "The inclusive floor lower bound. The repricing rule only applies when new price >= floor."
- },
- "useAutoPricingMinPrice": {
- "description": "If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "RepricingRuleRestrictionBoundary": {
- "description": "Definition of a boundary.",
- "id": "RepricingRuleRestrictionBoundary",
- "properties": {
- "percentageDelta": {
- "description": "The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.",
- "format": "int32",
- "type": "integer"
- },
- "priceDelta": {
- "description": "The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RepricingRuleStatsBasedRule": {
- "description": "Definition of stats based rule.",
- "id": "RepricingRuleStatsBasedRule",
- "properties": {
- "percentageDelta": {
- "description": "The percent change against the price target. Valid from 0 to 100 inclusively.",
- "format": "int32",
- "type": "integer"
- },
- "priceDelta": {
- "description": "The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnAddress": {
- "description": "Return address resource.",
- "id": "ReturnAddress",
- "properties": {
- "address": {
- "$ref": "ReturnAddressAddress",
- "description": "Required. The address."
- },
- "country": {
- "description": "Required. The country of sale where the return address is applicable.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\"",
- "type": "string"
- },
- "label": {
- "description": "Required. The user-defined label of the return address. For the default address, use the label \"default\".",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Required. The merchant's contact phone number regarding the return.",
- "type": "string"
- },
- "returnAddressId": {
- "description": "Return address ID generated by Google.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnAddressAddress": {
- "id": "ReturnAddressAddress",
- "properties": {
- "country": {
- "description": "CLDR country code (e.g. \"US\").",
- "type": "string"
- },
- "locality": {
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal code or ZIP (e.g. \"94043\").",
- "type": "string"
- },
- "recipientName": {
- "description": "Name of the recipient to address returns to.",
- "type": "string"
- },
- "region": {
- "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
- },
- "streetAddress": {
- "description": "Street-level part of the address. May be up to two lines, each line specified as an array element.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReturnPolicy": {
- "description": "Return policy resource.",
- "id": "ReturnPolicy",
- "properties": {
- "country": {
- "description": "Required. The country of sale where the return policy is applicable.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnPolicy`\"",
- "type": "string"
- },
- "label": {
- "description": "Required. The user-defined label of the return policy. For the default policy, use the label \"default\".",
- "type": "string"
- },
- "name": {
- "description": "Required. The name of the policy as shown in Merchant Center.",
- "type": "string"
- },
- "nonFreeReturnReasons": {
- "description": "Return reasons that will incur return fees.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "policy": {
- "$ref": "ReturnPolicyPolicy",
- "description": "Required. The policy."
- },
- "returnPolicyId": {
- "description": "Return policy ID generated by Google.",
- "type": "string"
- },
- "returnShippingFee": {
- "$ref": "Price",
- "description": "The return shipping fee that will apply to non free return reasons."
- },
- "seasonalOverrides": {
- "description": "An optional list of seasonal overrides.",
- "items": {
- "$ref": "ReturnPolicySeasonalOverride"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnline": {
- "description": "Return policy online object. This is currently used to represent return policies for ads and free listings programs.",
- "id": "ReturnPolicyOnline",
- "properties": {
- "countries": {
- "description": "The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. \"US\".",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemConditions": {
- "description": "The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "enum": [
- "ITEM_CONDITION_UNSPECIFIED",
- "NEW",
- "USED"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "New.",
- "Used."
- ],
- "type": "string"
- },
- "type": "array"
- },
- "label": {
- "description": "The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.",
- "type": "string"
- },
- "name": {
- "description": "The name of the policy as shown in Merchant Center.",
- "type": "string"
- },
- "policy": {
- "$ref": "ReturnPolicyOnlinePolicy",
- "description": "The return policy."
- },
- "restockingFee": {
- "$ref": "ReturnPolicyOnlineRestockingFee",
- "description": "The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set."
- },
- "returnMethods": {
- "description": "The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "enum": [
- "RETURN_METHOD_UNSPECIFIED",
- "BY_MAIL",
- "IN_STORE",
- "AT_A_KIOSK"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "By mail.",
- "In store.",
- "At a kiosk."
- ],
- "type": "string"
- },
- "type": "array"
- },
- "returnPolicyId": {
- "description": "Output only. Return policy ID generated by Google.",
- "readOnly": true,
- "type": "string"
- },
- "returnPolicyUri": {
- "description": "The return policy uri. This can used by Google to do a sanity check for the policy.",
- "type": "string"
- },
- "returnReasonCategoryInfo": {
- "description": "The return reason category information. This required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "$ref": "ReturnPolicyOnlineReturnReasonCategoryInfo"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlinePolicy": {
- "description": "The available policies.",
- "id": "ReturnPolicyOnlinePolicy",
- "properties": {
- "days": {
- "description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Policy type.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "NUMBER_OF_DAYS_AFTER_DELIVERY",
- "NO_RETURNS",
- "LIFETIME_RETURNS"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Number of days after a return is delivered.",
- "No returns.",
- "Life time returns."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineRestockingFee": {
- "description": "The restocking fee. This can either be a fixed fee or a micro percent.",
- "id": "ReturnPolicyOnlineRestockingFee",
- "properties": {
- "fixedFee": {
- "$ref": "PriceAmount",
- "description": "Fixed restocking fee."
- },
- "microPercent": {
- "description": "Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineReturnReasonCategoryInfo": {
- "description": "The return reason category info wrapper.",
- "id": "ReturnPolicyOnlineReturnReasonCategoryInfo",
- "properties": {
- "returnLabelSource": {
- "description": "The corresponding return label source.",
- "enum": [
- "RETURN_LABEL_SOURCE_UNSPECIFIED",
- "DOWNLOAD_AND_PRINT",
- "IN_THE_BOX",
- "CUSTOMER_RESPONSIBILITY"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Download and print the label.",
- "Label in the box.",
- "Customers' responsibility to get the label."
- ],
- "type": "string"
- },
- "returnReasonCategory": {
- "description": "The return reason category.",
- "enum": [
- "RETURN_REASON_CATEGORY_UNSPECIFIED",
- "BUYER_REMORSE",
- "ITEM_DEFECT"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Buyer remorse.",
- "Item defect."
- ],
- "type": "string"
- },
- "returnShippingFee": {
- "$ref": "ReturnPolicyOnlineReturnShippingFee",
- "description": "The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility."
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineReturnShippingFee": {
- "description": "The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.",
- "id": "ReturnPolicyOnlineReturnShippingFee",
- "properties": {
- "fixedFee": {
- "$ref": "PriceAmount",
- "description": "Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set."
- },
- "type": {
- "description": "Type of return shipping fee.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "FIXED",
- "CUSTOMER_PAYING_ACTUAL_FEE"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "The return shipping fee is a fixed value.",
- "Customer will pay the actual return shipping fee."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnPolicyPolicy": {
- "id": "ReturnPolicyPolicy",
- "properties": {
- "lastReturnDate": {
- "description": "Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to \"lastReturnDate\". Use this for seasonal overrides only.",
- "type": "string"
- },
- "numberOfDays": {
- "description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to \"numberOfDaysAfterDelivery\". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Policy type. Use \"lastReturnDate\" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - \"`lastReturnDate`\" - \"`lifetimeReturns`\" - \"`noReturns`\" - \"`numberOfDaysAfterDelivery`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnPolicySeasonalOverride": {
- "id": "ReturnPolicySeasonalOverride",
- "properties": {
- "endDate": {
- "description": "Required. Last day on which the override applies. In ISO 8601 format.",
- "type": "string"
- },
- "name": {
- "description": "Required. The name of the seasonal override as shown in Merchant Center.",
- "type": "string"
- },
- "policy": {
- "$ref": "ReturnPolicyPolicy",
- "description": "Required. The policy which is in effect during that time."
- },
- "startDate": {
- "description": "Required. First day on which the override applies. In ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
+ "value": {
+ "description": "Value for additional google provided (as key-value pairs) annotation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderPickupDetails": {
+ "id": "OrderPickupDetails",
+ "properties": {
+ "address": {
+ "$ref": "OrderAddress",
+ "description": "Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location."
+ },
+ "collectors": {
+ "description": "Collectors authorized to pick up shipment from the pickup location.",
+ "items": {
+ "$ref": "OrderPickupDetailsCollector"
+ },
+ "type": "array"
+ },
+ "locationId": {
+ "description": "ID of the pickup location.",
+ "type": "string"
+ },
+ "pickupType": {
+ "description": "The pickup type of this order. Acceptable values are: - \"`merchantStore`\" - \"`merchantStoreCurbside`\" - \"`merchantStoreLocker`\" - \"`thirdPartyPickupPoint`\" - \"`thirdPartyLocker`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderPickupDetailsCollector": {
+ "id": "OrderPickupDetailsCollector",
+ "properties": {
+ "name": {
+ "description": "Name of the person picking up the shipment.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number of the person picking up the shipment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderPromotion": {
+ "id": "OrderPromotion",
+ "properties": {
+ "applicableItems": {
+ "description": "Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.",
+ "items": {
+ "$ref": "OrderPromotionItem"
+ },
+ "type": "array"
+ },
+ "appliedItems": {
+ "description": "Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.",
+ "items": {
+ "$ref": "OrderPromotionItem"
+ },
+ "type": "array"
+ },
+ "endTime": {
+ "description": "Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".",
+ "type": "string"
+ },
+ "funder": {
+ "description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - \"`google`\" - \"`merchant`\" ",
+ "type": "string"
+ },
+ "merchantPromotionId": {
+ "description": "Required. This field is used to identify promotions within merchants' own systems.",
+ "type": "string"
+ },
+ "priceValue": {
+ "$ref": "Price",
+ "description": "Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order."
+ },
+ "shortTitle": {
+ "description": "A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".",
+ "type": "string"
+ },
+ "subtype": {
+ "description": "Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`. Acceptable values are: - \"`buyMGetMoneyOff`\" - \"`buyMGetNMoneyOff`\" - \"`buyMGetNPercentOff`\" - \"`buyMGetPercentOff`\" - \"`freeGift`\" - \"`freeGiftWithItemId`\" - \"`freeGiftWithValue`\" - \"`freeShippingOvernight`\" - \"`freeShippingStandard`\" - \"`freeShippingTwoDay`\" - \"`moneyOff`\" - \"`percentOff`\" - \"`rewardPoints`\" - \"`salePrice`\" ",
+ "type": "string"
+ },
+ "taxValue": {
+ "$ref": "Price",
+ "description": "Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`."
+ },
+ "title": {
+ "description": "Required. The title of the promotion.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - \"`product`\" - \"`shipping`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderPromotionItem": {
+ "id": "OrderPromotionItem",
+ "properties": {
+ "lineItemId": {
+ "description": "The line item ID of a product. Do not provide for `orders.createtestorder`.",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "Required. Offer ID of a product. Only for `orders.createtestorder`.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "`orders.createtestorder`.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity of the associated product. Do not provide for `orders.createtestorder`.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrderRefund": {
+ "id": "OrderRefund",
+ "properties": {
+ "actor": {
+ "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
+ "type": "string"
+ },
+ "amount": {
+ "$ref": "Price",
+ "description": "The amount that is refunded."
+ },
+ "creationDate": {
+ "description": "Date on which the item has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderReportDisbursement": {
+ "description": "Order disbursement. All methods require the payment analyst role.",
+ "id": "OrderReportDisbursement",
+ "properties": {
+ "disbursementAmount": {
+ "$ref": "Price",
+ "description": "The disbursement amount."
+ },
+ "disbursementCreationDate": {
+ "description": "The disbursement date, in ISO 8601 format.",
+ "type": "string"
+ },
+ "disbursementDate": {
+ "description": "The date the disbursement was initiated, in ISO 8601 format.",
+ "type": "string"
+ },
+ "disbursementId": {
+ "description": "The ID of the disbursement.",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderReportTransaction": {
+ "id": "OrderReportTransaction",
+ "properties": {
+ "disbursementAmount": {
+ "$ref": "Price",
+ "description": "The disbursement amount."
+ },
+ "disbursementCreationDate": {
+ "description": "The date the disbursement was created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "disbursementDate": {
+ "description": "The date the disbursement was initiated, in ISO 8601 format.",
+ "type": "string"
+ },
+ "disbursementId": {
+ "description": "The ID of the disbursement.",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "description": "Merchant-provided ID of the order.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "type": "string"
+ },
+ "productAmount": {
+ "$ref": "ProductAmount",
+ "description": "Total amount for the items."
+ },
+ "transactionDate": {
+ "description": "The date of the transaction, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderReturn": {
+ "id": "OrderReturn",
+ "properties": {
+ "actor": {
+ "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
+ "type": "string"
+ },
+ "creationDate": {
+ "description": "Date on which the item has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Quantity that is returned.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderShipment": {
+ "id": "OrderShipment",
+ "properties": {
+ "carrier": {
+ "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Priv\u00e9) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ",
+ "type": "string"
+ },
+ "creationDate": {
+ "description": "Date on which the shipment has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "deliveryDate": {
+ "description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID of the shipment.",
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "The line items that are shipped.",
+ "items": {
+ "$ref": "OrderShipmentLineItemShipment"
+ },
+ "type": "array"
+ },
+ "scheduledDeliveryDetails": {
+ "$ref": "OrderShipmentScheduledDeliveryDetails",
+ "description": "Delivery details of the shipment if scheduling is needed."
+ },
+ "shipmentGroupId": {
+ "description": "The shipment group ID of the shipment. This is set in shiplineitems request.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "The tracking ID for the shipment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderShipmentLineItemShipment": {
+ "id": "OrderShipmentLineItemShipment",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity that is shipped.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrderShipmentScheduledDeliveryDetails": {
+ "id": "OrderShipmentScheduledDeliveryDetails",
+ "properties": {
+ "carrierPhoneNumber": {
+ "description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., \"+41 44 668 1800\").",
+ "type": "string"
+ },
+ "scheduledDate": {
+ "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderTrackingSignal": {
+ "description": "Represents a merchant trade from which signals are extracted, e.g. shipping.",
+ "id": "OrderTrackingSignal",
+ "properties": {
+ "customerShippingFee": {
+ "$ref": "PriceAmount",
+ "description": "The shipping fee of the order; this value should be set to zero in the case of free shipping."
+ },
+ "deliveryPostalCode": {
+ "description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.",
+ "type": "string"
+ },
+ "deliveryRegionCode": {
+ "description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.",
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "Information about line items in the order.",
+ "items": {
+ "$ref": "OrderTrackingSignalLineItemDetails"
+ },
+ "type": "array"
+ },
+ "merchantId": {
+ "description": "The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).",
+ "format": "int64",
+ "type": "string"
+ },
+ "orderCreatedTime": {
+ "$ref": "DateTime",
+ "description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available."
+ },
+ "orderId": {
+ "description": "Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response.",
+ "type": "string"
+ },
+ "orderTrackingSignalId": {
+ "description": "Output only. The ID that uniquely identifies this order tracking signal.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "shipmentLineItemMapping": {
+ "description": "The mapping of the line items to the shipment information.",
+ "items": {
+ "$ref": "OrderTrackingSignalShipmentLineItemMapping"
+ },
+ "type": "array"
+ },
+ "shippingInfo": {
+ "description": "The shipping information for the order.",
+ "items": {
+ "$ref": "OrderTrackingSignalShippingInfo"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderTrackingSignalLineItemDetails": {
+ "description": "The line items of the order.",
+ "id": "OrderTrackingSignalLineItemDetails",
+ "properties": {
+ "gtin": {
+ "description": "The Global Trade Item Number.",
+ "type": "string"
+ },
+ "lineItemId": {
+ "description": "Required. The ID for this line item.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "The manufacturer part number.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Required. The quantity of the line item in the order.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderTrackingSignalShipmentLineItemMapping": {
+ "description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.",
+ "id": "OrderTrackingSignalShipmentLineItemMapping",
+ "properties": {
+ "lineItemId": {
+ "description": "Required. The line item ID.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Required. The line item quantity in the shipment.",
+ "format": "int64",
+ "type": "string"
+ },
+ "shipmentId": {
+ "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderTrackingSignalShippingInfo": {
+ "description": "The shipping information for the order.",
+ "id": "OrderTrackingSignalShippingInfo",
+ "properties": {
+ "actualDeliveryTime": {
+ "$ref": "DateTime",
+ "description": "The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
+ },
+ "carrierName": {
+ "description": "The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
+ "type": "string"
+ },
+ "carrierServiceName": {
+ "description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.",
+ "type": "string"
+ },
+ "earliestDeliveryPromiseTime": {
+ "$ref": "DateTime",
+ "description": "The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
+ },
+ "latestDeliveryPromiseTime": {
+ "$ref": "DateTime",
+ "description": "The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
+ },
+ "originPostalCode": {
+ "description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.",
+ "type": "string"
+ },
+ "originRegionCode": {
+ "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.",
+ "type": "string"
+ },
+ "shipmentId": {
+ "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.",
+ "type": "string"
+ },
+ "shippedTime": {
+ "$ref": "DateTime",
+ "description": "The time when the shipment was shipped. Include the year and timezone string, if available."
+ },
+ "shippingStatus": {
+ "description": "The status of the shipment.",
+ "enum": [
+ "SHIPPING_STATE_UNSPECIFIED",
+ "SHIPPED",
+ "DELIVERED"
+ ],
+ "enumDescriptions": [
+ "The shipping status is not known to merchant.",
+ "All items are shipped.",
+ "The shipment is already delivered."
+ ],
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCreateChargeInvoiceRequest": {
+ "id": "OrderinvoicesCreateChargeInvoiceRequest",
+ "properties": {
+ "invoiceId": {
+ "description": "[required] The ID of the invoice.",
+ "type": "string"
+ },
+ "invoiceSummary": {
+ "$ref": "InvoiceSummary",
+ "description": "[required] Invoice summary."
+ },
+ "lineItemInvoices": {
+ "description": "[required] Invoice details per line item.",
+ "items": {
+ "$ref": "ShipmentInvoiceLineItemInvoice"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order.",
+ "type": "string"
+ },
+ "shipmentGroupId": {
+ "description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCreateChargeInvoiceResponse": {
+ "id": "OrderinvoicesCreateChargeInvoiceResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateChargeInvoiceResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCreateRefundInvoiceRequest": {
+ "id": "OrderinvoicesCreateRefundInvoiceRequest",
+ "properties": {
+ "invoiceId": {
+ "description": "[required] The ID of the invoice.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order.",
+ "type": "string"
+ },
+ "refundOnlyOption": {
+ "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
+ "description": "Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
+ },
+ "returnOption": {
+ "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
+ "description": "Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
+ },
+ "shipmentInvoices": {
+ "description": "Invoice details for different shipment groups.",
+ "items": {
+ "$ref": "ShipmentInvoice"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCreateRefundInvoiceResponse": {
+ "id": "OrderinvoicesCreateRefundInvoiceResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateRefundInvoiceResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption": {
+ "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
+ "properties": {
+ "description": {
+ "description": "Optional description of the refund reason.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "[required] Reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption": {
+ "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
+ "properties": {
+ "description": {
+ "description": "Optional description of the return reason.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "[required] Reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreportsListDisbursementsResponse": {
+ "id": "OrderreportsListDisbursementsResponse",
+ "properties": {
+ "disbursements": {
+ "description": "The list of disbursements.",
+ "items": {
+ "$ref": "OrderReportDisbursement"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of disbursements.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreportsListTransactionsResponse": {
+ "id": "OrderreportsListTransactionsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of transactions.",
+ "type": "string"
+ },
+ "transactions": {
+ "description": "The list of transactions.",
+ "items": {
+ "$ref": "OrderReportTransaction"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsAcknowledgeRequest": {
+ "id": "OrderreturnsAcknowledgeRequest",
+ "properties": {
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order return.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsAcknowledgeResponse": {
+ "id": "OrderreturnsAcknowledgeResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsAcknowledgeResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsCreateOrderReturnRequest": {
+ "id": "OrderreturnsCreateOrderReturnRequest",
+ "properties": {
+ "lineItems": {
+ "description": "The list of line items to return.",
+ "items": {
+ "$ref": "OrderreturnsLineItem"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "type": "string"
+ },
+ "returnMethodType": {
+ "description": "The way of the package being returned.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsCreateOrderReturnResponse": {
+ "id": "OrderreturnsCreateOrderReturnResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsCreateOrderReturnResponse\".",
+ "type": "string"
+ },
+ "orderReturn": {
+ "$ref": "MerchantOrderReturn",
+ "description": "Created order return."
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsLineItem": {
+ "id": "OrderreturnsLineItem",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item. This value is assigned by Google when an order is created. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity of this line item.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsListResponse": {
+ "id": "OrderreturnsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of returns.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "MerchantOrderReturn"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsPartialRefund": {
+ "id": "OrderreturnsPartialRefund",
+ "properties": {
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The pre-tax or post-tax amount to be refunded, depending on the location of the order."
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "Tax amount to be refunded. Note: This has different meaning depending on the location of the order."
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsProcessRequest": {
+ "id": "OrderreturnsProcessRequest",
+ "properties": {
+ "fullChargeReturnShippingCost": {
+ "description": "Option to charge the customer return shipping cost.",
+ "type": "boolean"
+ },
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order return.",
+ "type": "string"
+ },
+ "refundShippingFee": {
+ "$ref": "OrderreturnsRefundOperation",
+ "description": "Refunds for original shipping fee."
+ },
+ "returnItems": {
+ "description": "The list of items to return.",
+ "items": {
+ "$ref": "OrderreturnsReturnItem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsProcessResponse": {
+ "id": "OrderreturnsProcessResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsProcessResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsRefundOperation": {
+ "id": "OrderreturnsRefundOperation",
+ "properties": {
+ "fullRefund": {
+ "description": "If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP.",
+ "type": "boolean"
+ },
+ "partialRefund": {
+ "$ref": "OrderreturnsPartialRefund",
+ "description": "If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer."
+ },
+ "paymentType": {
+ "description": "The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "returnRefundReason": {
+ "description": "Code of the refund reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsRejectOperation": {
+ "id": "OrderreturnsRejectOperation",
+ "properties": {
+ "reason": {
+ "description": "The reason for the return.",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreturnsReturnItem": {
+ "id": "OrderreturnsReturnItem",
+ "properties": {
+ "refund": {
+ "$ref": "OrderreturnsRefundOperation",
+ "description": "Refunds the item."
+ },
+ "reject": {
+ "$ref": "OrderreturnsRejectOperation",
+ "description": "Rejects the item."
+ },
+ "returnItemId": {
+ "description": "Unit level ID for the return item. Different units of the same product will have different IDs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersAcknowledgeRequest": {
+ "id": "OrdersAcknowledgeRequest",
+ "properties": {
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersAcknowledgeResponse": {
+ "id": "OrdersAcknowledgeResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersAdvanceTestOrderResponse": {
+ "id": "OrdersAdvanceTestOrderResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelLineItemRequest": {
+ "id": "OrdersCancelLineItemRequest",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to cancel. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity to cancel.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelLineItemResponse": {
+ "id": "OrdersCancelLineItemResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelRequest": {
+ "id": "OrdersCancelRequest",
+ "properties": {
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelResponse": {
+ "id": "OrdersCancelResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelTestOrderByCustomerRequest": {
+ "id": "OrdersCancelTestOrderByCustomerRequest",
+ "properties": {
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelTestOrderByCustomerResponse": {
+ "id": "OrdersCancelTestOrderByCustomerResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCreateTestOrderRequest": {
+ "id": "OrdersCreateTestOrderRequest",
+ "properties": {
+ "country": {
+ "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.",
+ "type": "string"
+ },
+ "templateName": {
+ "description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ",
+ "type": "string"
+ },
+ "testOrder": {
+ "$ref": "TestOrder",
+ "description": "The test order to create."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCreateTestOrderResponse": {
+ "id": "OrdersCreateTestOrderResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The ID of the newly created test order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCreateTestReturnRequest": {
+ "id": "OrdersCreateTestReturnRequest",
+ "properties": {
+ "items": {
+ "description": "Returned items.",
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCreateTestReturnResponse": {
+ "id": "OrdersCreateTestReturnResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\".",
+ "type": "string"
+ },
+ "returnId": {
+ "description": "The ID of the newly created test order return.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem": {
+ "id": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Quantity that is returned.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryRefundItemItem": {
+ "id": "OrdersCustomBatchRequestEntryRefundItemItem",
+ "properties": {
+ "amount": {
+ "$ref": "MonetaryAmount",
+ "description": "The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer."
+ },
+ "fullRefund": {
+ "description": "If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored.",
+ "type": "boolean"
+ },
+ "lineItemId": {
+ "description": "The ID of the line item. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The number of products that are refunded.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryRefundItemShipping": {
+ "id": "OrdersCustomBatchRequestEntryRefundItemShipping",
+ "properties": {
+ "amount": {
+ "$ref": "Price",
+ "description": "The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount."
+ },
+ "fullRefund": {
+ "description": "If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo": {
+ "id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo",
+ "properties": {
+ "carrier": {
+ "description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
+ "type": "string"
+ },
+ "shipmentId": {
+ "description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "The tracking ID for the shipment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails": {
+ "description": "ScheduledDeliveryDetails used to update the scheduled delivery order.",
+ "id": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails",
+ "properties": {
+ "carrierPhoneNumber": {
+ "description": "The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in",
+ "type": "string"
+ },
+ "scheduledDate": {
+ "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersGetByMerchantOrderIdResponse": {
+ "id": "OrdersGetByMerchantOrderIdResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".",
+ "type": "string"
+ },
+ "order": {
+ "$ref": "Order",
+ "description": "The requested order."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersGetTestOrderTemplateResponse": {
+ "id": "OrdersGetTestOrderTemplateResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".",
+ "type": "string"
+ },
+ "template": {
+ "$ref": "TestOrder",
+ "description": "The requested test order template."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersInStoreRefundLineItemRequest": {
+ "id": "OrdersInStoreRefundLineItemRequest",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required."
+ },
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity to return and refund.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "The amount of tax to be refunded. Required."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersInStoreRefundLineItemResponse": {
+ "id": "OrdersInStoreRefundLineItemResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersListResponse": {
+ "id": "OrdersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of orders.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundItemRequest": {
+ "id": "OrdersRefundItemRequest",
+ "properties": {
+ "items": {
+ "description": "The items that are refunded. Either Item or Shipping must be provided in the request.",
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryRefundItemItem"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the refund. Acceptable values are: - \"`shippingCostAdjustment`\" - \"`priceAdjustment`\" - \"`taxAdjustment`\" - \"`feeAdjustment`\" - \"`courtesyAdjustment`\" - \"`adjustment`\" - \"`customerCancelled`\" - \"`noInventory`\" - \"`productNotAsDescribed`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" - \"`lateShipmentCredit`\" - \"`deliveredLateByCarrier`\" - \"`productArrivedDamaged`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "shipping": {
+ "$ref": "OrdersCustomBatchRequestEntryRefundItemShipping",
+ "description": "The refund on shipping. Optional, but either Item or Shipping must be provided in the request."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundItemResponse": {
+ "id": "OrdersRefundItemResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundItemResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundOrderRequest": {
+ "id": "OrdersRefundOrderRequest",
+ "properties": {
+ "amount": {
+ "$ref": "MonetaryAmount",
+ "description": "The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount."
+ },
+ "fullRefund": {
+ "description": "If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored.",
+ "type": "boolean"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the refund. Acceptable values are: - \"`courtesyAdjustment`\" - \"`other`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundOrderResponse": {
+ "id": "OrdersRefundOrderResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundOrderResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRejectReturnLineItemRequest": {
+ "id": "OrdersRejectReturnLineItemRequest",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity to return and refund.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRejectReturnLineItemResponse": {
+ "id": "OrdersRejectReturnLineItemResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRejectReturnLineItemResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersReturnRefundLineItemRequest": {
+ "id": "OrdersReturnRefundLineItemRequest",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed."
+ },
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity to return and refund. Quantity is required.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersReturnRefundLineItemResponse": {
+ "id": "OrdersReturnRefundLineItemResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnRefundLineItemResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersSetLineItemMetadataRequest": {
+ "id": "OrdersSetLineItemMetadataRequest",
+ "properties": {
+ "annotations": {
+ "items": {
+ "$ref": "OrderMerchantProvidedAnnotation"
+ },
+ "type": "array"
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersSetLineItemMetadataResponse": {
+ "id": "OrdersSetLineItemMetadataResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersShipLineItemsRequest": {
+ "id": "OrdersShipLineItemsRequest",
+ "properties": {
+ "lineItems": {
+ "description": "Line items to ship.",
+ "items": {
+ "$ref": "OrderShipmentLineItemShipment"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "shipmentGroupId": {
+ "description": "ID of the shipment group. Required for orders that use the orderinvoices service.",
+ "type": "string"
+ },
+ "shipmentInfos": {
+ "description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersShipLineItemsResponse": {
+ "id": "OrdersShipLineItemsResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateLineItemShippingDetailsRequest": {
+ "id": "OrdersUpdateLineItemShippingDetailsRequest",
+ "properties": {
+ "deliverByDate": {
+ "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
+ "type": "string"
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "shipByDate": {
+ "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateLineItemShippingDetailsResponse": {
+ "id": "OrdersUpdateLineItemShippingDetailsResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateMerchantOrderIdRequest": {
+ "id": "OrdersUpdateMerchantOrderIdRequest",
+ "properties": {
+ "merchantOrderId": {
+ "description": "The merchant order id to be assigned to the order. Must be unique per merchant.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateMerchantOrderIdResponse": {
+ "id": "OrdersUpdateMerchantOrderIdResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateShipmentRequest": {
+ "id": "OrdersUpdateShipmentRequest",
+ "properties": {
+ "carrier": {
+ "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
+ "type": "string"
+ },
+ "deliveryDate": {
+ "description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.",
+ "type": "string"
+ },
+ "lastPickupDate": {
+ "description": "Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and `status` is `ready for pickup`.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "readyPickupDate": {
+ "description": "Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if `status` is `ready for pickup`.",
+ "type": "string"
+ },
+ "scheduledDeliveryDetails": {
+ "$ref": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails",
+ "description": "Delivery details of the shipment if scheduling is needed."
+ },
+ "shipmentId": {
+ "description": "The ID of the shipment.",
+ "type": "string"
+ },
+ "status": {
+ "description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" ",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "The tracking ID for the shipment. Not updated if missing.",
+ "type": "string"
+ },
+ "undeliveredDate": {
+ "description": "Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if `status` is `undeliverable`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersUpdateShipmentResponse": {
+ "id": "OrdersUpdateShipmentResponse",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PauseBuyOnGoogleProgramRequest": {
+ "description": "Request message for the PauseProgram method.",
+ "id": "PauseBuyOnGoogleProgramRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "PaymentServiceProviderLinkInfo": {
+ "description": "Additional information required for PAYMENT_SERVICE_PROVIDER link type.",
+ "id": "PaymentServiceProviderLinkInfo",
+ "properties": {
+ "externalAccountBusinessCountry": {
+ "description": "The business country of the merchant account as identified by the third party service provider.",
+ "type": "string"
+ },
+ "externalAccountId": {
+ "description": "The id used by the third party service provider to identify the merchant.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PickupCarrierService": {
+ "id": "PickupCarrierService",
+ "properties": {
+ "carrierName": {
+ "description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required.",
+ "type": "string"
+ },
+ "serviceName": {
+ "description": "The name of the pickup service (e.g., `\"Access point\"`). Required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PickupServicesPickupService": {
+ "id": "PickupServicesPickupService",
+ "properties": {
+ "carrierName": {
+ "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
+ "type": "string"
+ },
+ "serviceName": {
+ "description": "The name of the pickup service (e.g., `\"Access point\"`). Always present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchRequest": {
+ "id": "PosCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "PosCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchRequestEntry": {
+ "id": "PosCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "inventory": {
+ "$ref": "PosInventory",
+ "description": "The inventory to submit. This should be set only if the method is `inventory`."
+ },
+ "merchantId": {
+ "description": "The ID of the POS data provider.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" ",
+ "type": "string"
+ },
+ "sale": {
+ "$ref": "PosSale",
+ "description": "The sale information to submit. This should be set only if the method is `sale`."
+ },
+ "store": {
+ "$ref": "PosStore",
+ "description": "The store information to submit. This should be set only if the method is `insert`."
+ },
+ "storeCode": {
+ "description": "The store code. This should be set only if the method is `delete` or `get`.",
+ "type": "string"
+ },
+ "targetMerchantId": {
+ "description": "The ID of the account for which to get/submit data.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchResponse": {
+ "id": "PosCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "PosCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchResponseEntry": {
+ "id": "PosCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ },
+ "inventory": {
+ "$ref": "PosInventory",
+ "description": "The updated inventory information."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "sale": {
+ "$ref": "PosSale",
+ "description": "The updated sale information."
+ },
+ "store": {
+ "$ref": "PosStore",
+ "description": "The retrieved or updated store information."
+ }
+ },
+ "type": "object"
+ },
+ "PosDataProviders": {
+ "id": "PosDataProviders",
+ "properties": {
+ "country": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "posDataProviders": {
+ "description": "A list of POS data providers.",
+ "items": {
+ "$ref": "PosDataProvidersPosDataProvider"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PosDataProvidersPosDataProvider": {
+ "id": "PosDataProvidersPosDataProvider",
+ "properties": {
+ "displayName": {
+ "description": "The display name of Pos data Provider.",
+ "type": "string"
+ },
+ "fullName": {
+ "description": "The full name of this POS data Provider.",
+ "type": "string"
+ },
+ "providerId": {
+ "description": "The ID of the account.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosInventory": {
+ "description": "The absolute quantity of an item available at the given store.",
+ "id": "PosInventory",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The current price of the item."
+ },
+ "quantity": {
+ "description": "Required. The available quantity of the item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosInventoryRequest": {
+ "id": "PosInventoryRequest",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The current price of the item."
+ },
+ "quantity": {
+ "description": "Required. The available quantity of the item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosInventoryResponse": {
+ "id": "PosInventoryResponse",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\".",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The current price of the item."
+ },
+ "quantity": {
+ "description": "Required. The available quantity of the item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosListResponse": {
+ "id": "PosListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\".",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "PosStore"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PosSale": {
+ "description": "The change of the available quantity of an item at the given store.",
+ "id": "PosSale",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\"",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price of the item."
+ },
+ "quantity": {
+ "description": "Required. The relative change of the available quantity. Negative for items returned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "saleId": {
+ "description": "A unique ID to group items from the same sale event.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosSaleRequest": {
+ "id": "PosSaleRequest",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price of the item."
+ },
+ "quantity": {
+ "description": "Required. The relative change of the available quantity. Negative for items returned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "saleId": {
+ "description": "A unique ID to group items from the same sale event.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosSaleResponse": {
+ "id": "PosSaleResponse",
+ "properties": {
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\".",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price of the item."
+ },
+ "quantity": {
+ "description": "Required. The relative change of the available quantity. Negative for items returned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "saleId": {
+ "description": "A unique ID to group items from the same sale event.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosStore": {
+ "description": "Store resource.",
+ "id": "PosStore",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\"",
+ "type": "string"
+ },
+ "storeAddress": {
+ "description": "Required. The street address of the store.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. A store identifier that is unique for the given merchant.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodeGroup": {
+ "id": "PostalCodeGroup",
+ "properties": {
+ "country": {
+ "description": "The CLDR territory code of the country the postal code group applies to. Required.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the postal code group, referred to in headers. Required.",
+ "type": "string"
+ },
+ "postalCodeRanges": {
+ "description": "A range of postal codes. Required.",
+ "items": {
+ "$ref": "PostalCodeRange"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodeRange": {
+ "id": "PostalCodeRange",
+ "properties": {
+ "postalCodeRangeBegin": {
+ "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `\"94108\"`, `\"9410*\"`, `\"9*\"`. Required.",
+ "type": "string"
+ },
+ "postalCodeRangeEnd": {
+ "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Price": {
+ "id": "Price",
+ "properties": {
+ "currency": {
+ "description": "The currency of the price.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The price represented as a number.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PriceAmount": {
+ "description": "The price represented as a number and currency.",
+ "id": "PriceAmount",
+ "properties": {
+ "currency": {
+ "description": "The currency of the price.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The price represented as a number.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Product": {
+ "description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.",
+ "id": "Product",
+ "properties": {
+ "additionalImageLinks": {
+ "description": "Additional URLs of images of the item.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ReturnPricingInfo": {
- "id": "ReturnPricingInfo",
- "properties": {
- "chargeReturnShippingFee": {
- "description": "Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.",
- "type": "boolean"
- },
- "maxReturnShippingFee": {
- "$ref": "MonetaryAmount",
- "description": "Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned."
- },
- "refundableItemsTotalAmount": {
- "$ref": "MonetaryAmount",
- "description": "Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons."
- },
- "refundableShippingAmount": {
- "$ref": "MonetaryAmount",
- "description": "Maximum amount that can be refunded for the original shipping fee."
- },
- "totalRefundedAmount": {
- "$ref": "MonetaryAmount",
- "description": "Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet."
- }
- },
- "type": "object"
+ "additionalSizeType": {
+ "description": "Additional cut of the item. Used together with size_type to represent combined size types for apparel items.",
+ "type": "string"
},
- "ReturnShipment": {
- "id": "ReturnShipment",
- "properties": {
- "creationDate": {
- "description": "The date of creation of the shipment, in ISO 8601 format.",
- "type": "string"
- },
- "deliveryDate": {
- "description": "The date of delivery of the shipment, in ISO 8601 format.",
- "type": "string"
- },
- "returnMethodType": {
- "description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" - \"`inStore`\" ",
- "type": "string"
- },
- "shipmentId": {
- "description": "Shipment ID generated by Google.",
- "type": "string"
- },
- "shipmentTrackingInfos": {
- "description": "Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.",
- "items": {
- "$ref": "ShipmentTrackingInfo"
- },
- "type": "array"
- },
- "shippingDate": {
- "description": "The date of shipping of the shipment, in ISO 8601 format.",
- "type": "string"
- },
- "state": {
- "description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnaddressCustomBatchRequest": {
- "id": "ReturnaddressCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ReturnaddressCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "adsGrouping": {
+ "description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.",
+ "type": "string"
},
- "ReturnaddressCustomBatchRequestEntry": {
- "id": "ReturnaddressCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The Merchant Center account ID.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
- "type": "string"
- },
- "returnAddress": {
- "$ref": "ReturnAddress",
- "description": "The return address to submit. This should be set only if the method is `insert`."
- },
- "returnAddressId": {
- "description": "The return address ID. This should be set only if the method is `delete` or `get`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnaddressCustomBatchResponse": {
- "id": "ReturnaddressCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ReturnaddressCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "adsLabels": {
+ "description": "Similar to ads_grouping, but only works on CPC.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "adsRedirect": {
+ "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.",
+ "type": "string"
+ },
+ "adult": {
+ "description": "Should be set to true if the item is targeted towards adults.",
+ "type": "boolean"
+ },
+ "ageGroup": {
+ "description": "Target age group of the item.",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability status of the item.",
+ "type": "string"
+ },
+ "availabilityDate": {
+ "description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format.",
+ "type": "string"
+ },
+ "brand": {
+ "description": "Brand of the item.",
+ "type": "string"
+ },
+ "canonicalLink": {
+ "description": "URL for the canonical version of your item's landing page.",
+ "type": "string"
+ },
+ "channel": {
+ "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ",
+ "type": "string"
+ },
+ "color": {
+ "description": "Color of the item.",
+ "type": "string"
+ },
+ "condition": {
+ "description": "Condition or state of the item.",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "costOfGoodsSold": {
+ "$ref": "Price",
+ "description": "Cost of goods sold. Used for gross profit reporting."
+ },
+ "customAttributes": {
+ "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).",
+ "items": {
+ "$ref": "CustomAttribute"
+ },
+ "type": "array"
+ },
+ "customLabel0": {
+ "description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "customLabel1": {
+ "description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "customLabel2": {
+ "description": "Custom label 2 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "customLabel3": {
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "customLabel4": {
+ "description": "Custom label 4 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the item.",
+ "type": "string"
+ },
+ "displayAdsId": {
+ "description": "An identifier for an item for dynamic remarketing campaigns.",
+ "type": "string"
+ },
+ "displayAdsLink": {
+ "description": "URL directly to your item's landing page for dynamic remarketing campaigns.",
+ "type": "string"
+ },
+ "displayAdsSimilarIds": {
+ "description": "Advertiser-specified recommendations.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ReturnaddressCustomBatchResponseEntry": {
- "id": "ReturnaddressCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "returnAddress": {
- "$ref": "ReturnAddress",
- "description": "The retrieved return address."
- }
- },
- "type": "object"
+ "displayAdsTitle": {
+ "description": "Title of an item for dynamic remarketing campaigns.",
+ "type": "string"
},
- "ReturnaddressListResponse": {
- "id": "ReturnaddressListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of addresses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ReturnAddress"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReturnpolicyCustomBatchRequest": {
- "id": "ReturnpolicyCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ReturnpolicyCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "displayAdsValue": {
+ "description": "Offer margin for dynamic remarketing campaigns.",
+ "format": "double",
+ "type": "number"
},
- "ReturnpolicyCustomBatchRequestEntry": {
- "id": "ReturnpolicyCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The Merchant Center account ID.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
- "type": "string"
- },
- "returnPolicy": {
- "$ref": "ReturnPolicy",
- "description": "The return policy to submit. This should be set only if the method is `insert`."
- },
- "returnPolicyId": {
- "description": "The return policy ID. This should be set only if the method is `delete` or `get`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnpolicyCustomBatchResponse": {
- "id": "ReturnpolicyCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ReturnpolicyCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "energyEfficiencyClass": {
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
+ "type": "string"
},
- "ReturnpolicyCustomBatchResponseEntry": {
- "id": "ReturnpolicyCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnpolicyCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "returnPolicy": {
- "$ref": "ReturnPolicy",
- "description": "The retrieved return policy."
- }
- },
- "type": "object"
+ "excludedDestinations": {
+ "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ReturnpolicyListResponse": {
- "id": "ReturnpolicyListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyListResponse\".",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ReturnPolicy"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Row": {
- "id": "Row",
- "properties": {
- "cells": {
- "description": "The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.",
- "items": {
- "$ref": "Value"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "expirationDate": {
+ "description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.",
+ "type": "string"
},
- "SearchRequest": {
- "description": "Request message for the ReportService.Search method.",
- "id": "SearchRequest",
- "properties": {
- "pageSize": {
- "description": "Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000.",
- "format": "int32",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.",
- "type": "string"
- },
- "query": {
- "description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. ",
- "type": "string"
- }
- },
- "type": "object"
+ "gender": {
+ "description": "Target gender of the item.",
+ "type": "string"
},
- "SearchResponse": {
- "description": "Response message for the ReportService.Search method.",
- "id": "SearchResponse",
- "properties": {
- "nextPageToken": {
- "description": "Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages.",
- "type": "string"
- },
- "results": {
- "description": "Rows that matched the search query.",
- "items": {
- "$ref": "ReportRow"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "googleProductCategory": {
+ "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.",
+ "type": "string"
},
- "Segments": {
- "description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.",
- "id": "Segments",
- "properties": {
- "date": {
- "$ref": "Date",
- "description": "Date in the merchant timezone to which metrics apply."
- },
- "offerId": {
- "description": "Merchant-provided id of the product.",
- "type": "string"
- },
- "program": {
- "description": "Program to which metrics apply, e.g., Free Product Listing.",
- "enum": [
- "PROGRAM_UNSPECIFIED",
- "SHOPPING_ADS",
- "FREE_PRODUCT_LISTING",
- "FREE_LOCAL_PRODUCT_LISTING",
- "BUY_ON_GOOGLE_LISTING"
- ],
- "enumDescriptions": [
- "Not specified.",
- "Shopping Ads.",
- "Free Product Listing.",
- "Free Local Product Listing.",
- "Buy on Google Listing."
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item.",
+ "type": "string"
},
- "Service": {
- "id": "Service",
- "properties": {
- "active": {
- "description": "A boolean exposing the active status of the shipping service. Required.",
- "type": "boolean"
- },
- "currency": {
- "description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.",
- "type": "string"
- },
- "deliveryCountry": {
- "description": "The CLDR territory code of the country to which the service applies. Required.",
- "type": "string"
- },
- "deliveryTime": {
- "$ref": "DeliveryTime",
- "description": "Time spent in various aspects from order to the delivery of the product. Required."
- },
- "eligibility": {
- "description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
- "type": "string"
- },
- "minimumOrderValue": {
- "$ref": "Price",
- "description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table."
- },
- "minimumOrderValueTable": {
- "$ref": "MinimumOrderValueTable",
- "description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value."
- },
- "name": {
- "description": "Free-form name of the service. Must be unique within target account. Required.",
- "type": "string"
- },
- "pickupService": {
- "$ref": "PickupCarrierService",
- "description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`."
- },
- "rateGroups": {
- "description": "Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means \"everything else\". The other `applicableShippingLabels` must not overlap.",
- "items": {
- "$ref": "RateGroup"
- },
- "type": "array"
- },
- "shipmentType": {
- "description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "id": {
+ "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.",
+ "type": "string"
},
- "SettlementReport": {
- "description": " Settlement reports detail order-level and item-level credits and debits between you and Google.",
- "id": "SettlementReport",
- "properties": {
- "endDate": {
- "description": "The end date on which all transactions are included in the report, in ISO 8601 format.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementReport`\"",
- "type": "string"
- },
- "previousBalance": {
- "$ref": "Price",
- "description": "The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance."
- },
- "settlementId": {
- "description": "The ID of the settlement report.",
- "type": "string"
- },
- "startDate": {
- "description": "The start date on which all transactions are included in the report, in ISO 8601 format.",
- "type": "string"
- },
- "transferAmount": {
- "$ref": "Price",
- "description": "The money due to the merchant."
- },
- "transferDate": {
- "description": "Date on which transfer for this payment was initiated by Google, in ISO 8601 format.",
- "type": "string"
- },
- "transferIds": {
- "description": "The list of bank identifiers used for the transfer. e.g. Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "identifierExists": {
+ "description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.",
+ "type": "boolean"
},
- "SettlementTransaction": {
- "description": "Settlement transactions give a detailed breakdown of the settlement report.",
- "id": "SettlementTransaction",
- "properties": {
- "amount": {
- "$ref": "SettlementTransactionAmount",
- "description": "The amount for the transaction."
- },
- "identifiers": {
- "$ref": "SettlementTransactionIdentifiers",
- "description": "Identifiers of the transaction."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\"",
- "type": "string"
- },
- "transaction": {
- "$ref": "SettlementTransactionTransaction",
- "description": "Details of the transaction."
- }
- },
- "type": "object"
+ "imageLink": {
+ "description": "URL of an image of the item.",
+ "type": "string"
},
- "SettlementTransactionAmount": {
- "id": "SettlementTransactionAmount",
- "properties": {
- "commission": {
- "$ref": "SettlementTransactionAmountCommission"
- },
- "description": {
- "description": "The description of the event. Acceptable values are: - \"`taxWithhold`\" - \"`principal`\" - \"`principalAdjustment`\" - \"`shippingFee`\" - \"`merchantRemittedSalesTax`\" - \"`googleRemittedSalesTax`\" - \"`merchantCoupon`\" - \"`merchantCouponTax`\" - \"`merchantRemittedDisposalTax`\" - \"`googleRemittedDisposalTax`\" - \"`merchantRemittedRedemptionFee`\" - \"`googleRemittedRedemptionFee`\" - \"`eeeEcoFee`\" - \"`furnitureEcoFee`\" - \"`copyPrivateFee`\" - \"`eeeEcoFeeCommission`\" - \"`furnitureEcoFeeCommission`\" - \"`copyPrivateFeeCommission`\" - \"`principalRefund`\" - \"`principalRefundTax`\" - \"`itemCommission`\" - \"`adjustmentCommission`\" - \"`shippingFeeCommission`\" - \"`commissionRefund`\" - \"`damaged`\" - \"`damagedOrDefectiveItem`\" - \"`expiredItem`\" - \"`faultyItem`\" - \"`incorrectItemReceived`\" - \"`itemMissing`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`storePackageMissing`\" - \"`transitPackageMissing`\" - \"`unsuccessfulDeliveryUndeliverable`\" - \"`wrongChargeInStore`\" - \"`wrongItem`\" - \"`returns`\" - \"`undeliverable`\" - \"`issueRelatedRefundAndReplacementAmountDescription`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" - \"`lumpSumCorrection`\" - \"`pspFee`\" ",
- "type": "string"
- },
- "transactionAmount": {
- "$ref": "Price",
- "description": "The amount that contributes to the line item price."
- },
- "type": {
- "description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" - \"`lumpSumCorrectionAmount`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "includedDestinations": {
+ "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "installment": {
+ "$ref": "Installment",
+ "description": "Number and amount of installments to pay for an item."
+ },
+ "isBundle": {
+ "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.",
+ "type": "boolean"
+ },
+ "itemGroupId": {
+ "description": "Shared identifier for all variants of the same product.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
+ "type": "string"
+ },
+ "link": {
+ "description": "URL directly linking to your item's page on your website.",
+ "type": "string"
+ },
+ "loyaltyPoints": {
+ "$ref": "LoyaltyPoints",
+ "description": "Loyalty points that users receive after purchasing the item. Japan only."
+ },
+ "material": {
+ "description": "The material of which the item is made.",
+ "type": "string"
+ },
+ "maxEnergyEfficiencyClass": {
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
+ "type": "string"
+ },
+ "maxHandlingTime": {
+ "description": "Maximal product handling time (in business days).",
+ "format": "int64",
+ "type": "string"
+ },
+ "minEnergyEfficiencyClass": {
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
+ "type": "string"
+ },
+ "minHandlingTime": {
+ "description": "Minimal product handling time (in business days).",
+ "format": "int64",
+ "type": "string"
+ },
+ "mobileLink": {
+ "description": "URL for the mobile-optimized version of your item's landing page.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "Manufacturer Part Number (MPN) of the item.",
+ "type": "string"
+ },
+ "multipack": {
+ "description": "The number of identical products in a merchant-defined multipack.",
+ "format": "int64",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.",
+ "type": "string"
+ },
+ "pattern": {
+ "description": "The item's pattern (e.g. polka dots).",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Price of the item."
+ },
+ "productDetails": {
+ "description": "Technical specification or additional product details.",
+ "items": {
+ "$ref": "ProductProductDetail"
+ },
+ "type": "array"
+ },
+ "productHighlights": {
+ "description": "Bullet points describing the most relevant highlights of a product.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "SettlementTransactionAmountCommission": {
- "id": "SettlementTransactionAmountCommission",
- "properties": {
- "category": {
- "description": "The category of the commission. Acceptable values are: - \"`animalsAndPetSupplies`\" - \"`dogCatFoodAndCatLitter`\" - \"`apparelAndAccessories`\" - \"`shoesHandbagsAndSunglasses`\" - \"`costumesAndAccessories`\" - \"`jewelry`\" - \"`watches`\" - \"`hobbiesArtsAndCrafts`\" - \"`homeAndGarden`\" - \"`entertainmentCollectibles`\" - \"`collectibleCoins`\" - \"`sportsCollectibles`\" - \"`sportingGoods`\" - \"`toysAndGames`\" - \"`musicalInstruments`\" - \"`giftCards`\" - \"`babyAndToddler`\" - \"`babyFoodWipesAndDiapers`\" - \"`businessAndIndustrial`\" - \"`camerasOpticsAndPhotography`\" - \"`consumerElectronics`\" - \"`electronicsAccessories`\" - \"`personalComputers`\" - \"`videoGameConsoles`\" - \"`foodAndGrocery`\" - \"`beverages`\" - \"`tobaccoProducts`\" - \"`furniture`\" - \"`hardware`\" - \"`buildingMaterials`\" - \"`tools`\" - \"`healthAndPersonalCare`\" - \"`beauty`\" - \"`householdSupplies`\" - \"`kitchenAndDining`\" - \"`majorAppliances`\" - \"`luggageAndBags`\" - \"`media`\" - \"`officeSupplies`\" - \"`softwareAndVideoGames`\" - \"`vehiclePartsAndAccessories`\" - \"`vehicleTiresAndWheels`\" - \"`vehicles`\" - \"`everythingElse`\" ",
- "type": "string"
- },
- "rate": {
- "description": "Rate of the commission in percentage.",
- "type": "string"
- }
- },
- "type": "object"
+ "productTypes": {
+ "description": "Categories of the item (formatted as in products data specification).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "SettlementTransactionIdentifiers": {
- "id": "SettlementTransactionIdentifiers",
- "properties": {
- "adjustmentId": {
- "description": "The identifier of the adjustments, if it is available.",
- "type": "string"
- },
- "merchantOrderId": {
- "description": "The merchant provided order ID.",
- "type": "string"
- },
- "orderItemId": {
- "description": "The identifier of the item.",
- "type": "string"
- },
- "settlementEntryId": {
- "description": "The unique ID of the settlement transaction entry.",
- "type": "string"
- },
- "shipmentIds": {
- "description": "The shipment ids for the item.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "transactionId": {
- "description": "The Google transaction ID.",
- "type": "string"
- }
- },
- "type": "object"
+ "promotionIds": {
+ "description": "The unique ID of a promotion.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "salePrice": {
+ "$ref": "Price",
+ "description": "Advertised sale price of the item."
+ },
+ "salePriceEffectiveDate": {
+ "description": "Date range during which the item is on sale (see products data specification ).",
+ "type": "string"
+ },
+ "sellOnGoogleQuantity": {
+ "description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
+ "format": "int64",
+ "type": "string"
+ },
+ "shipping": {
+ "description": "Shipping rules.",
+ "items": {
+ "$ref": "ProductShipping"
+ },
+ "type": "array"
+ },
+ "shippingHeight": {
+ "$ref": "ProductShippingDimension",
+ "description": "Height of the item for shipping."
+ },
+ "shippingLabel": {
+ "description": "The shipping label of the product, used to group product in account-level shipping rules.",
+ "type": "string"
+ },
+ "shippingLength": {
+ "$ref": "ProductShippingDimension",
+ "description": "Length of the item for shipping."
+ },
+ "shippingWeight": {
+ "$ref": "ProductShippingWeight",
+ "description": "Weight of the item for shipping."
+ },
+ "shippingWidth": {
+ "$ref": "ProductShippingDimension",
+ "description": "Width of the item for shipping."
+ },
+ "shoppingAdsExcludedCountries": {
+ "description": "List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "SettlementTransactionTransaction": {
- "id": "SettlementTransactionTransaction",
- "properties": {
- "postDate": {
- "description": "The time on which the event occurred in ISO 8601 format.",
- "type": "string"
- },
- "type": {
- "description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" - \"`lumpSumCorrectionTransaction`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "sizeSystem": {
+ "description": "System in which the size is specified. Recommended for apparel items.",
+ "type": "string"
},
- "SettlementreportsListResponse": {
- "id": "SettlementreportsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementreportsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of returns.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "SettlementReport"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "sizeType": {
+ "description": "The cut of the item. Recommended for apparel items.",
+ "type": "string"
},
- "SettlementtransactionsListResponse": {
- "id": "SettlementtransactionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementtransactionsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of returns.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "SettlementTransaction"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "sizes": {
+ "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "source": {
+ "description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ",
+ "type": "string"
+ },
+ "subscriptionCost": {
+ "$ref": "ProductSubscriptionCost",
+ "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract."
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "taxCategory": {
+ "description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
+ "type": "string"
+ },
+ "taxes": {
+ "description": "Tax information.",
+ "items": {
+ "$ref": "ProductTax"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "Title of the item.",
+ "type": "string"
+ },
+ "transitTimeLabel": {
+ "description": "The transit time label of the product, used to group product in account-level transit time tables.",
+ "type": "string"
+ },
+ "unitPricingBaseMeasure": {
+ "$ref": "ProductUnitPricingBaseMeasure",
+ "description": "The preference of the denominator of the unit price."
+ },
+ "unitPricingMeasure": {
+ "$ref": "ProductUnitPricingMeasure",
+ "description": "The measure and dimension of an item."
+ }
+ },
+ "type": "object"
+ },
+ "ProductAmount": {
+ "id": "ProductAmount",
+ "properties": {
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The pre-tax or post-tax price depending on the location of the order."
+ },
+ "remittedTaxAmount": {
+ "$ref": "Price",
+ "description": "Remitted tax value."
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "Tax value."
+ }
+ },
+ "type": "object"
+ },
+ "ProductProductDetail": {
+ "id": "ProductProductDetail",
+ "properties": {
+ "attributeName": {
+ "description": "The name of the product detail.",
+ "type": "string"
+ },
+ "attributeValue": {
+ "description": "The value of the product detail.",
+ "type": "string"
+ },
+ "sectionName": {
+ "description": "The section header used to group a set of product details.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductShipping": {
+ "id": "ProductShipping",
+ "properties": {
+ "country": {
+ "description": "The CLDR territory code of the country to which an item will ship.",
+ "type": "string"
+ },
+ "locationGroupName": {
+ "description": "The location where the shipping is applicable, represented by a location group name.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxHandlingTime": {
+ "description": "Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxTransitTime": {
+ "description": "Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minHandlingTime": {
+ "description": "Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minTransitTime": {
+ "description": "Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.",
+ "format": "int64",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Fixed shipping price, represented as a number."
+ },
+ "region": {
+ "description": "The geographic region to which a shipping rate applies.",
+ "type": "string"
+ },
+ "service": {
+ "description": "A free-form description of the service class or delivery speed.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductShippingDimension": {
+ "id": "ProductShippingDimension",
+ "properties": {
+ "unit": {
+ "description": "The unit of value.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The dimension of the product used to calculate the shipping cost of the item.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ProductShippingWeight": {
+ "id": "ProductShippingWeight",
+ "properties": {
+ "unit": {
+ "description": "The unit of value.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The weight of the product used to calculate the shipping cost of the item.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ProductStatus": {
+ "description": "The status of a product, i.e., information about a product computed asynchronously.",
+ "id": "ProductStatus",
+ "properties": {
+ "creationDate": {
+ "description": "Date on which the item has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "destinationStatuses": {
+ "description": "The intended destinations for the product.",
+ "items": {
+ "$ref": "ProductStatusDestinationStatus"
+ },
+ "type": "array"
+ },
+ "googleExpirationDate": {
+ "description": "Date on which the item expires in Google Shopping, in ISO 8601 format.",
+ "type": "string"
+ },
+ "itemLevelIssues": {
+ "description": "A list of all issues associated with the product.",
+ "items": {
+ "$ref": "ProductStatusItemLevelIssue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"",
+ "type": "string"
+ },
+ "lastUpdateDate": {
+ "description": "Date on which the item has been last updated, in ISO 8601 format.",
+ "type": "string"
+ },
+ "link": {
+ "description": "The link to the product.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product for which status is reported.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the product.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductStatusDestinationStatus": {
+ "id": "ProductStatusDestinationStatus",
+ "properties": {
+ "approvedCountries": {
+ "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ShipmentInvoice": {
- "id": "ShipmentInvoice",
- "properties": {
- "invoiceSummary": {
- "$ref": "InvoiceSummary",
- "description": "[required] Invoice summary."
- },
- "lineItemInvoices": {
- "description": "[required] Invoice details per line item.",
- "items": {
- "$ref": "ShipmentInvoiceLineItemInvoice"
- },
- "type": "array"
- },
- "shipmentGroupId": {
- "description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
- "type": "string"
- }
- },
- "type": "object"
+ "destination": {
+ "description": "The name of the destination",
+ "type": "string"
},
- "ShipmentInvoiceLineItemInvoice": {
- "id": "ShipmentInvoiceLineItemInvoice",
- "properties": {
- "lineItemId": {
- "description": "ID of the line item. Either lineItemId or productId must be set.",
- "type": "string"
- },
- "productId": {
- "description": "ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.",
- "type": "string"
- },
- "shipmentUnitIds": {
- "description": "[required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "unitInvoice": {
- "$ref": "UnitInvoice",
- "description": "[required] Invoice details for a single unit."
- }
- },
- "type": "object"
+ "disapprovedCountries": {
+ "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ShipmentTrackingInfo": {
- "id": "ShipmentTrackingInfo",
- "properties": {
- "carrier": {
- "description": "The shipping carrier that handles the package. Acceptable values are: - \"`boxtal`\" - \"`bpost`\" - \"`chronopost`\" - \"`colisPrive`\" - \"`colissimo`\" - \"`cxt`\" - \"`deliv`\" - \"`dhl`\" - \"`dpd`\" - \"`dynamex`\" - \"`eCourier`\" - \"`easypost`\" - \"`efw`\" - \"`fedex`\" - \"`fedexSmartpost`\" - \"`geodis`\" - \"`gls`\" - \"`googleCourier`\" - \"`gsx`\" - \"`jdLogistics`\" - \"`laPoste`\" - \"`lasership`\" - \"`manual`\" - \"`mpx`\" - \"`onTrac`\" - \"`other`\" - \"`tnt`\" - \"`uds`\" - \"`ups`\" - \"`usps`\" ",
- "type": "string"
- },
- "trackingNumber": {
- "description": "The tracking number for the package.",
- "type": "string"
- }
- },
- "type": "object"
+ "pendingCountries": {
+ "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ShippingSettings": {
- "description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
- "id": "ShippingSettings",
- "properties": {
- "accountId": {
- "description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.",
- "format": "uint64",
- "type": "string"
- },
- "postalCodeGroups": {
- "description": "A list of postal code groups that can be referred to in `services`. Optional.",
- "items": {
- "$ref": "PostalCodeGroup"
- },
- "type": "array"
- },
- "services": {
- "description": "The target account's list of services. Optional.",
- "items": {
- "$ref": "Service"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchRequest": {
- "id": "ShippingsettingsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ShippingsettingsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "status": {
+ "description": "Destination approval status in `targetCountry` of the offer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductStatusItemLevelIssue": {
+ "id": "ProductStatusItemLevelIssue",
+ "properties": {
+ "applicableCountries": {
+ "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "ShippingsettingsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch shippingsettings request.",
- "id": "ShippingsettingsCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account shipping settings.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
- "type": "string"
- },
- "shippingSettings": {
- "$ref": "ShippingSettings",
- "description": "The account shipping settings to update. Only defined if the method is `update`."
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchResponse": {
- "id": "ShippingsettingsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ShippingsettingsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "attributeName": {
+ "description": "The attribute's name, if the issue is caused by a single attribute.",
+ "type": "string"
},
- "ShippingsettingsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch shipping settings response.",
- "id": "ShippingsettingsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "shippingSettings": {
- "$ref": "ShippingSettings",
- "description": "The retrieved or updated account shipping settings."
- }
- },
- "type": "object"
- },
- "ShippingsettingsGetSupportedCarriersResponse": {
- "id": "ShippingsettingsGetSupportedCarriersResponse",
- "properties": {
- "carriers": {
- "description": "A list of supported carriers. May be empty.",
- "items": {
- "$ref": "CarriersCarrier"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShippingsettingsGetSupportedHolidaysResponse": {
- "id": "ShippingsettingsGetSupportedHolidaysResponse",
- "properties": {
- "holidays": {
- "description": "A list of holidays applicable for delivery guarantees. May be empty.",
- "items": {
- "$ref": "HolidaysHoliday"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\".",
- "type": "string"
- }
- },
- "type": "object"
+ "code": {
+ "description": "The error code of the issue.",
+ "type": "string"
},
- "ShippingsettingsGetSupportedPickupServicesResponse": {
- "id": "ShippingsettingsGetSupportedPickupServicesResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\".",
- "type": "string"
- },
- "pickupServices": {
- "description": "A list of supported pickup services. May be empty.",
- "items": {
- "$ref": "PickupServicesPickupService"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "description": {
+ "description": "A short issue description in English.",
+ "type": "string"
},
- "ShippingsettingsListResponse": {
- "id": "ShippingsettingsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of shipping settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ShippingSettings"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "destination": {
+ "description": "The destination the issue applies to.",
+ "type": "string"
},
- "Table": {
- "id": "Table",
- "properties": {
- "columnHeaders": {
- "$ref": "Headers",
- "description": "Headers of the table's columns. Optional: if not set then the table has only one dimension."
- },
- "name": {
- "description": "Name of the table. Required for subtables, ignored for the main table.",
- "type": "string"
- },
- "rowHeaders": {
- "$ref": "Headers",
- "description": "Headers of the table's rows. Required."
- },
- "rows": {
- "description": "The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.",
- "items": {
- "$ref": "Row"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "detail": {
+ "description": "A detailed issue description in English.",
+ "type": "string"
+ },
+ "documentation": {
+ "description": "The URL of a web page to help with resolving this issue.",
+ "type": "string"
+ },
+ "resolution": {
+ "description": "Whether the issue can be resolved by the merchant.",
+ "type": "string"
+ },
+ "servability": {
+ "description": "How this issue affects serving of the offer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductSubscriptionCost": {
+ "id": "ProductSubscriptionCost",
+ "properties": {
+ "amount": {
+ "$ref": "Price",
+ "description": "The amount the buyer has to pay per subscription period."
+ },
+ "period": {
+ "description": "The type of subscription period.",
+ "type": "string"
+ },
+ "periodLength": {
+ "description": "The number of subscription periods the buyer has to pay.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductTax": {
+ "id": "ProductTax",
+ "properties": {
+ "country": {
+ "description": "The country within which the item is taxed, specified as a CLDR territory code.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
+ "format": "int64",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.",
+ "type": "string"
+ },
+ "rate": {
+ "description": "The percentage of tax rate that applies to the item price.",
+ "format": "double",
+ "type": "number"
+ },
+ "region": {
+ "description": "The geographic region to which the tax rate applies.",
+ "type": "string"
+ },
+ "taxShip": {
+ "description": "Should be set to true if tax is charged on shipping.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ProductUnitPricingBaseMeasure": {
+ "id": "ProductUnitPricingBaseMeasure",
+ "properties": {
+ "unit": {
+ "description": "The unit of the denominator.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The denominator of the unit price.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductUnitPricingMeasure": {
+ "id": "ProductUnitPricingMeasure",
+ "properties": {
+ "unit": {
+ "description": "The unit of the measure.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The measure of an item.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsCustomBatchRequest": {
+ "id": "ProductsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "ProductsCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch products request.",
+ "id": "ProductsCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "feedId": {
+ "description": "The Content API feed id.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
+ "type": "string"
+ },
+ "product": {
+ "$ref": "Product",
+ "description": "The product to insert. Only required if the method is `insert`."
+ },
+ "productId": {
+ "description": "The ID of the product to get or delete. Only defined if the method is `get` or `delete`.",
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "The comma-separated list of product attributes to be updated. Example: `\"title,salePrice\"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is `update`.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsCustomBatchResponse": {
+ "id": "ProductsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ProductsCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch products response.",
+ "id": "ProductsCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "product": {
+ "$ref": "Product",
+ "description": "The inserted product. Only defined if the method is `insert` and if the request was successful."
+ }
+ },
+ "type": "object"
+ },
+ "ProductsListResponse": {
+ "id": "ProductsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of products.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchRequest": {
+ "id": "ProductstatusesCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "ProductstatusesCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch productstatuses request.",
+ "id": "ProductstatusesCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includeAttributes": {
+ "type": "boolean"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product whose status to get.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchResponse": {
+ "id": "ProductstatusesCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ProductstatusesCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch productstatuses response.",
+ "id": "ProductstatusesCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors, if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "productStatus": {
+ "$ref": "ProductStatus",
+ "description": "The requested product status. Only defined if the request was successful."
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesListResponse": {
+ "id": "ProductstatusesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of products statuses.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "ProductStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PubsubNotificationSettings": {
+ "description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
+ "id": "PubsubNotificationSettings",
+ "properties": {
+ "cloudTopicName": {
+ "description": "Cloud pub/sub topic to which notifications are sent (read-only).",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\"",
+ "type": "string"
+ },
+ "registeredEvents": {
+ "description": "List of event types. Acceptable values are: - \"`orderPendingShipment`\" ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RateGroup": {
+ "id": "RateGroup",
+ "properties": {
+ "applicableShippingLabels": {
+ "description": "A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "carrierRates": {
+ "description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`.",
+ "items": {
+ "$ref": "CarrierRate"
+ },
+ "type": "array"
+ },
+ "mainTable": {
+ "$ref": "Table",
+ "description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set."
+ },
+ "name": {
+ "description": "Name of the rate group. Optional. If set has to be unique within shipping service.",
+ "type": "string"
+ },
+ "singleValue": {
+ "$ref": "Value",
+ "description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set."
+ },
+ "subtables": {
+ "description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.",
+ "items": {
+ "$ref": "Table"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RefundReason": {
+ "id": "RefundReason",
+ "properties": {
+ "description": {
+ "description": "Description of the reason.",
+ "type": "string"
+ },
+ "reasonCode": {
+ "description": "Code of the refund reason. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Region": {
+ "description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.",
+ "id": "Region",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the region.",
+ "type": "string"
+ },
+ "geotargetArea": {
+ "$ref": "RegionGeoTargetArea",
+ "description": "A list of geotargets that defines the region area."
+ },
+ "merchantId": {
+ "description": "Output only. Immutable. Merchant that owns the region.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "postalCodeArea": {
+ "$ref": "RegionPostalCodeArea",
+ "description": "A list of postal codes that defines the region area."
+ },
+ "regionId": {
+ "description": "Output only. Immutable. The ID uniquely identifying each region.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "regionalInventoryEligible": {
+ "description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "shippingEligible": {
+ "description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.",
+ "readOnly": true,
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "RegionGeoTargetArea": {
+ "description": "A list of geotargets that defines the region area.",
+ "id": "RegionGeoTargetArea",
+ "properties": {
+ "geotargetCriteriaIds": {
+ "description": "Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RegionPostalCodeArea": {
+ "description": "A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.",
+ "id": "RegionPostalCodeArea",
+ "properties": {
+ "postalCodes": {
+ "description": "Required. A range of postal codes.",
+ "items": {
+ "$ref": "RegionPostalCodeAreaPostalCodeRange"
+ },
+ "type": "array"
+ },
+ "regionCode": {
+ "description": "Required. CLDR territory code or the country the postal code group applies to.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionPostalCodeAreaPostalCodeRange": {
+ "description": "A range of postal codes that defines the region area.",
+ "id": "RegionPostalCodeAreaPostalCodeRange",
+ "properties": {
+ "begin": {
+ "description": "Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: \"94108\", \"9410*\", \"9*\".",
+ "type": "string"
+ },
+ "end": {
+ "description": "Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionalInventory": {
+ "description": "Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.",
+ "id": "RegionalInventory",
+ "properties": {
+ "availability": {
+ "description": "The availability of the product.",
+ "type": "string"
+ },
+ "customAttributes": {
+ "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.",
+ "items": {
+ "$ref": "CustomAttribute"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalInventory\".",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The price of the product."
+ },
+ "regionId": {
+ "description": "The ID uniquely identifying each region.",
+ "type": "string"
+ },
+ "salePrice": {
+ "$ref": "Price",
+ "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
+ },
+ "salePriceEffectiveDate": {
+ "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionalinventoryCustomBatchRequest": {
+ "id": "RegionalinventoryCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "RegionalinventoryCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RegionalinventoryCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch regional inventory request.",
+ "id": "RegionalinventoryCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product for which to update price and availability.",
+ "type": "string"
+ },
+ "regionalInventory": {
+ "$ref": "RegionalInventory",
+ "description": "Price and availability of the product."
+ }
+ },
+ "type": "object"
+ },
+ "RegionalinventoryCustomBatchResponse": {
+ "id": "RegionalinventoryCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "RegionalinventoryCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionalinventoryCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch regional inventory response.",
+ "id": "RegionalinventoryCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponseEntry\".",
+ "type": "string"
+ },
+ "regionalInventory": {
+ "$ref": "RegionalInventory",
+ "description": "Price and availability of the product."
+ }
+ },
+ "type": "object"
+ },
+ "ReportRow": {
+ "description": "Result row returned from the search query.",
+ "id": "ReportRow",
+ "properties": {
+ "metrics": {
+ "$ref": "Metrics",
+ "description": "Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query."
+ },
+ "segments": {
+ "$ref": "Segments",
+ "description": "Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query."
+ }
+ },
+ "type": "object"
+ },
+ "RepricingProductReport": {
+ "description": "Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.",
+ "id": "RepricingProductReport",
+ "properties": {
+ "applicationCount": {
+ "description": "Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period.",
+ "format": "int64",
+ "type": "string"
+ },
+ "buyboxWinningProductStats": {
+ "$ref": "RepricingProductReportBuyboxWinningProductStats",
+ "description": "Stats specific to buybox winning rules for product report (deprecated)."
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone."
+ },
+ "highWatermark": {
+ "$ref": "PriceAmount",
+ "description": "Maximum displayed price after repriced during this reporting period."
+ },
+ "inapplicabilityDetails": {
+ "description": "List of all reasons the rule did not apply to the product during the specified reporting period.",
+ "items": {
+ "$ref": "InapplicabilityDetails"
+ },
+ "type": "array"
+ },
+ "lowWatermark": {
+ "$ref": "PriceAmount",
+ "description": "Minimum displayed price after repriced during this reporting period."
+ },
+ "orderItemCount": {
+ "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ruleIds": {
+ "description": "Ids of the Repricing rule for this report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "totalGmv": {
+ "$ref": "PriceAmount",
+ "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed."
+ },
+ "type": {
+ "description": "Type of the rule.",
+ "enum": [
+ "REPRICING_RULE_TYPE_UNSPECIFIED",
+ "TYPE_STATS_BASED",
+ "TYPE_COGS_BASED"
+ ],
+ "enumDescriptions": [
+ "Unused.",
+ "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
+ "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingProductReportBuyboxWinningProductStats": {
+ "description": "Stats specific to buybox winning rules for product report.",
+ "id": "RepricingProductReportBuyboxWinningProductStats",
+ "properties": {
+ "buyboxWinsCount": {
+ "description": "Number of times this product won the buybox with these rules during this time period.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRule": {
+ "description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24",
+ "id": "RepricingRule",
+ "properties": {
+ "cogsBasedRule": {
+ "$ref": "RepricingRuleCostOfGoodsSaleRule",
+ "description": "The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED."
+ },
+ "countryCode": {
+ "description": "Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\").",
+ "type": "string"
+ },
+ "effectiveTimePeriod": {
+ "$ref": "RepricingRuleEffectiveTime",
+ "description": "Required. Time period when the rule should take effect."
+ },
+ "eligibleOfferMatcher": {
+ "$ref": "RepricingRuleEligibleOfferMatcher",
+ "description": "Required. Match criteria for the eligible offers."
+ },
+ "languageCode": {
+ "description": "Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Output only. Immutable. Merchant that owns the repricing rule.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "paused": {
+ "description": "Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.",
+ "type": "boolean"
+ },
+ "restriction": {
+ "$ref": "RepricingRuleRestriction",
+ "description": "Required. Restriction of the rule appliance."
+ },
+ "ruleId": {
+ "description": "Output only. Immutable. The ID to uniquely identify each repricing rule.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "statsBasedRule": {
+ "$ref": "RepricingRuleStatsBasedRule",
+ "description": "The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED."
+ },
+ "title": {
+ "description": "The title for the rule.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. Immutable. The type of the rule.",
+ "enum": [
+ "REPRICING_RULE_TYPE_UNSPECIFIED",
+ "TYPE_STATS_BASED",
+ "TYPE_COGS_BASED"
+ ],
+ "enumDescriptions": [
+ "Unused.",
+ "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
+ "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleCostOfGoodsSaleRule": {
+ "description": "A repricing rule that changes the sale price based on cost of goods sale.",
+ "id": "RepricingRuleCostOfGoodsSaleRule",
+ "properties": {
+ "percentageDelta": {
+ "description": "The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "priceDelta": {
+ "description": "The price delta against the COGS. E.g. 2 means $2 more of the COGS.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleEffectiveTime": {
+ "id": "RepricingRuleEffectiveTime",
+ "properties": {
+ "fixedTimePeriods": {
+ "description": "A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.",
+ "items": {
+ "$ref": "RepricingRuleEffectiveTimeFixedTimePeriod"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleEffectiveTimeFixedTimePeriod": {
+ "description": "Definition of a fixed time period.",
+ "id": "RepricingRuleEffectiveTimeFixedTimePeriod",
+ "properties": {
+ "endTime": {
+ "description": "The end time (exclusive) of the period. It can only be hour granularity.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The start time (inclusive) of the period. It can only be hour granularity.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleEligibleOfferMatcher": {
+ "description": "Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.",
+ "id": "RepricingRuleEligibleOfferMatcher",
+ "properties": {
+ "brandMatcher": {
+ "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
+ "description": "Filter by the brand."
+ },
+ "itemGroupIdMatcher": {
+ "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
+ "description": "Filter by the item group id."
+ },
+ "matcherOption": {
+ "description": "Determines whether to use the custom matchers or the product feed attribute \"repricing_rule_id\" to specify offer-rule mapping.",
+ "enum": [
+ "MATCHER_OPTION_UNSPECIFIED",
+ "MATCHER_OPTION_CUSTOM_FILTER",
+ "MATCHER_OPTION_USE_FEED_ATTRIBUTE",
+ "MATCHER_OPTION_ALL_PRODUCTS"
+ ],
+ "enumDescriptions": [
+ "Unused.",
+ "Use custom filters.",
+ "Use repricing_rule_id feed attribute on the product resource to specify offer-rule mapping.",
+ "Matching all products."
+ ],
+ "type": "string"
+ },
+ "offerIdMatcher": {
+ "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
+ "description": "Filter by the offer id."
+ },
+ "skipWhenOnPromotion": {
+ "description": "When true, the rule won't be applied to offers with active promotions.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleEligibleOfferMatcherStringMatcher": {
+ "description": "Matcher by string attributes.",
+ "id": "RepricingRuleEligibleOfferMatcherStringMatcher",
+ "properties": {
+ "strAttributes": {
+ "description": "String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regex.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleReport": {
+ "description": "Resource that represents a daily Repricing rule report. Next ID: 11",
+ "id": "RepricingRuleReport",
+ "properties": {
+ "buyboxWinningRuleStats": {
+ "$ref": "RepricingRuleReportBuyboxWinningRuleStats",
+ "description": "Stats specific to buybox winning rules for rule report (deprecated)."
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone."
+ },
+ "impactedProducts": {
+ "description": "List of product ids that are impacted by this rule during this reporting period. Out of stock products and products not searched for by customers are examples of non-impacted products.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "inapplicabilityDetails": {
+ "description": "List of all reasons the rule did not apply to the inapplicable products during the specified reporting period.",
+ "items": {
+ "$ref": "InapplicabilityDetails"
+ },
+ "type": "array"
+ },
+ "inapplicableProducts": {
+ "description": "List of product ids that are inapplicable to this rule during this reporting period. To get the inapplicable reason for a specific product, see RepricingProductReport.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "orderItemCount": {
+ "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ruleId": {
+ "description": "Id of the Repricing rule for this report.",
+ "type": "string"
+ },
+ "totalGmv": {
+ "$ref": "PriceAmount",
+ "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed."
+ },
+ "type": {
+ "description": "Type of the rule.",
+ "enum": [
+ "REPRICING_RULE_TYPE_UNSPECIFIED",
+ "TYPE_STATS_BASED",
+ "TYPE_COGS_BASED"
+ ],
+ "enumDescriptions": [
+ "Unused.",
+ "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
+ "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleReportBuyboxWinningRuleStats": {
+ "description": "Stats specific to buybox winning rules for rule report.",
+ "id": "RepricingRuleReportBuyboxWinningRuleStats",
+ "properties": {
+ "buyboxWonProductCount": {
+ "description": "Number of unique products that won the buybox with this rule during this period of time.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleRestriction": {
+ "description": "Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is \"-10\" and the floor.price_delta is \"-12\", the offer price will only be lowered $5 (10% lower than the original offer price).",
+ "id": "RepricingRuleRestriction",
+ "properties": {
+ "floor": {
+ "$ref": "RepricingRuleRestrictionBoundary",
+ "description": "The inclusive floor lower bound. The repricing rule only applies when new price >= floor."
+ },
+ "useAutoPricingMinPrice": {
+ "description": "If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleRestrictionBoundary": {
+ "description": "Definition of a boundary.",
+ "id": "RepricingRuleRestrictionBoundary",
+ "properties": {
+ "percentageDelta": {
+ "description": "The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "priceDelta": {
+ "description": "The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepricingRuleStatsBasedRule": {
+ "description": "Definition of stats based rule.",
+ "id": "RepricingRuleStatsBasedRule",
+ "properties": {
+ "percentageDelta": {
+ "description": "The percent change against the price target. Valid from 0 to 100 inclusively.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "priceDelta": {
+ "description": "The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RequestReviewBuyOnGoogleProgramRequest": {
+ "description": "Request message for the RequestReviewProgram method.",
+ "id": "RequestReviewBuyOnGoogleProgramRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ReturnAddress": {
+ "description": "Return address resource.",
+ "id": "ReturnAddress",
+ "properties": {
+ "address": {
+ "$ref": "ReturnAddressAddress",
+ "description": "Required. The address."
+ },
+ "country": {
+ "description": "Required. The country of sale where the return address is applicable.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\"",
+ "type": "string"
+ },
+ "label": {
+ "description": "Required. The user-defined label of the return address. For the default address, use the label \"default\".",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Required. The merchant's contact phone number regarding the return.",
+ "type": "string"
+ },
+ "returnAddressId": {
+ "description": "Return address ID generated by Google.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnAddressAddress": {
+ "id": "ReturnAddressAddress",
+ "properties": {
+ "country": {
+ "description": "CLDR country code (e.g. \"US\").",
+ "type": "string"
+ },
+ "locality": {
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code or ZIP (e.g. \"94043\").",
+ "type": "string"
+ },
+ "recipientName": {
+ "description": "Name of the recipient to address returns to.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
+ "type": "string"
+ },
+ "streetAddress": {
+ "description": "Street-level part of the address. May be up to two lines, each line specified as an array element.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicy": {
+ "description": "Return policy resource.",
+ "id": "ReturnPolicy",
+ "properties": {
+ "country": {
+ "description": "Required. The country of sale where the return policy is applicable.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnPolicy`\"",
+ "type": "string"
+ },
+ "label": {
+ "description": "Required. The user-defined label of the return policy. For the default policy, use the label \"default\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the policy as shown in Merchant Center.",
+ "type": "string"
+ },
+ "nonFreeReturnReasons": {
+ "description": "Return reasons that will incur return fees.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "policy": {
+ "$ref": "ReturnPolicyPolicy",
+ "description": "Required. The policy."
+ },
+ "returnPolicyId": {
+ "description": "Return policy ID generated by Google.",
+ "type": "string"
+ },
+ "returnShippingFee": {
+ "$ref": "Price",
+ "description": "The return shipping fee that will apply to non free return reasons."
+ },
+ "seasonalOverrides": {
+ "description": "An optional list of seasonal overrides.",
+ "items": {
+ "$ref": "ReturnPolicySeasonalOverride"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyOnline": {
+ "description": "Return policy online object. This is currently used to represent return policies for ads and free listings programs.",
+ "id": "ReturnPolicyOnline",
+ "properties": {
+ "countries": {
+ "description": "The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. \"US\".",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "TestOrder": {
- "id": "TestOrder",
- "properties": {
- "deliveryDetails": {
- "$ref": "TestOrderDeliveryDetails",
- "description": "Overrides the predefined delivery details if provided."
- },
- "enableOrderinvoices": {
- "description": "Whether the orderinvoices service should support this order.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\"",
- "type": "string"
- },
- "lineItems": {
- "description": "Required. Line items that are ordered. At least one line item must be provided.",
- "items": {
- "$ref": "TestOrderLineItem"
- },
- "type": "array"
- },
- "notificationMode": {
- "description": "Restricted. Do not use.",
- "type": "string"
- },
- "pickupDetails": {
- "$ref": "TestOrderPickupDetails",
- "description": "Overrides the predefined pickup details if provided."
- },
- "predefinedBillingAddress": {
- "description": "Required. The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
- "type": "string"
- },
- "predefinedDeliveryAddress": {
- "description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
- "type": "string"
- },
- "predefinedEmail": {
- "description": "Required. Email address of the customer. Acceptable values are: - \"`pog.dwight.schrute@gmail.com`\" - \"`pog.jim.halpert@gmail.com`\" - \"`penpog.pam.beesly@gmail.comding`\" ",
- "type": "string"
- },
- "predefinedPickupDetails": {
- "description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
- "type": "string"
- },
- "promotions": {
- "description": "Promotions associated with the order.",
- "items": {
- "$ref": "OrderPromotion"
- },
- "type": "array"
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states."
- },
- "shippingOption": {
- "description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "itemConditions": {
+ "description": "The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.",
+ "items": {
+ "enum": [
+ "ITEM_CONDITION_UNSPECIFIED",
+ "NEW",
+ "USED"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "New.",
+ "Used."
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
- "TestOrderAddress": {
- "id": "TestOrderAddress",
- "properties": {
- "country": {
- "description": "CLDR country code (e.g. \"US\").",
- "type": "string"
- },
- "fullAddress": {
- "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "isPostOfficeBox": {
- "description": "Whether the address is a post office box.",
- "type": "boolean"
- },
- "locality": {
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal Code or ZIP (e.g. \"94043\").",
- "type": "string"
- },
- "recipientName": {
- "description": "Name of the recipient.",
- "type": "string"
- },
- "region": {
- "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
- },
- "streetAddress": {
- "description": "Street-level part of the address.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "label": {
+ "description": "The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.",
+ "type": "string"
},
- "TestOrderDeliveryDetails": {
- "id": "TestOrderDeliveryDetails",
- "properties": {
- "address": {
- "$ref": "TestOrderAddress",
- "description": "The delivery address"
- },
- "isScheduledDelivery": {
- "description": "Whether the order is scheduled delivery order.",
- "type": "boolean"
- },
- "phoneNumber": {
- "description": "The phone number of the person receiving the delivery.",
- "type": "string"
- }
- },
- "type": "object"
+ "name": {
+ "description": "The name of the policy as shown in Merchant Center.",
+ "type": "string"
},
- "TestOrderLineItem": {
- "id": "TestOrderLineItem",
- "properties": {
- "product": {
- "$ref": "TestOrderLineItemProduct",
- "description": "Required. Product data from the time of the order placement."
- },
- "quantityOrdered": {
- "description": "Required. Number of items ordered.",
- "format": "uint32",
- "type": "integer"
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Required. Details of the return policy for the line item."
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Required. Details of the requested shipping for the line item."
- }
- },
- "type": "object"
+ "policy": {
+ "$ref": "ReturnPolicyOnlinePolicy",
+ "description": "The return policy."
},
- "TestOrderLineItemProduct": {
- "id": "TestOrderLineItemProduct",
- "properties": {
- "brand": {
- "description": "Required. Brand of the item.",
- "type": "string"
- },
- "condition": {
- "description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" ",
- "type": "string"
- },
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" ",
- "type": "string"
- },
- "fees": {
- "description": "Fees for the item. Optional.",
- "items": {
- "$ref": "OrderLineItemProductFee"
- },
- "type": "array"
- },
- "gtin": {
- "description": "Global Trade Item Number (GTIN) of the item. Optional.",
- "type": "string"
- },
- "imageLink": {
- "description": "Required. URL of an image of the item.",
- "type": "string"
- },
- "itemGroupId": {
- "description": "Shared identifier for all variants of the same product. Optional.",
- "type": "string"
- },
- "mpn": {
- "description": "Manufacturer Part Number (MPN) of the item. Optional.",
- "type": "string"
- },
- "offerId": {
- "description": "Required. An identifier of the item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied."
- },
- "targetCountry": {
- "description": "Required. The CLDR territory // code of the target country of the product.",
- "type": "string"
- },
- "title": {
- "description": "Required. The title of the product.",
- "type": "string"
- },
- "variantAttributes": {
- "description": "Variant attributes for the item. Optional.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "restockingFee": {
+ "$ref": "ReturnPolicyOnlineRestockingFee",
+ "description": "The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set."
},
- "TestOrderPickupDetails": {
- "id": "TestOrderPickupDetails",
- "properties": {
- "locationCode": {
- "description": "Required. Code of the location defined by provider or merchant.",
- "type": "string"
- },
- "pickupLocationAddress": {
- "$ref": "TestOrderAddress",
- "description": "Required. Pickup location address."
- },
- "pickupLocationType": {
- "description": "Pickup location type. Acceptable values are: - \"`locker`\" - \"`store`\" - \"`curbside`\" ",
- "type": "string"
- },
- "pickupPersons": {
- "description": "Required. all pickup persons set by users.",
- "items": {
- "$ref": "TestOrderPickupDetailsPickupPerson"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "returnMethods": {
+ "description": "The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.",
+ "items": {
+ "enum": [
+ "RETURN_METHOD_UNSPECIFIED",
+ "BY_MAIL",
+ "IN_STORE",
+ "AT_A_KIOSK"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "By mail.",
+ "In store.",
+ "At a kiosk."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "returnPolicyId": {
+ "description": "Output only. Return policy ID generated by Google.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "returnPolicyUri": {
+ "description": "The return policy uri. This can used by Google to do a sanity check for the policy.",
+ "type": "string"
+ },
+ "returnReasonCategoryInfo": {
+ "description": "The return reason category information. This required to not be empty unless the type of return policy is noReturns.",
+ "items": {
+ "$ref": "ReturnPolicyOnlineReturnReasonCategoryInfo"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyOnlinePolicy": {
+ "description": "The available policies.",
+ "id": "ReturnPolicyOnlinePolicy",
+ "properties": {
+ "days": {
+ "description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Policy type.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "NUMBER_OF_DAYS_AFTER_DELIVERY",
+ "NO_RETURNS",
+ "LIFETIME_RETURNS"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Number of days after a return is delivered.",
+ "No returns.",
+ "Life time returns."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyOnlineRestockingFee": {
+ "description": "The restocking fee. This can either be a fixed fee or a micro percent.",
+ "id": "ReturnPolicyOnlineRestockingFee",
+ "properties": {
+ "fixedFee": {
+ "$ref": "PriceAmount",
+ "description": "Fixed restocking fee."
+ },
+ "microPercent": {
+ "description": "Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyOnlineReturnReasonCategoryInfo": {
+ "description": "The return reason category info wrapper.",
+ "id": "ReturnPolicyOnlineReturnReasonCategoryInfo",
+ "properties": {
+ "returnLabelSource": {
+ "description": "The corresponding return label source.",
+ "enum": [
+ "RETURN_LABEL_SOURCE_UNSPECIFIED",
+ "DOWNLOAD_AND_PRINT",
+ "IN_THE_BOX",
+ "CUSTOMER_RESPONSIBILITY"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Download and print the label.",
+ "Label in the box.",
+ "Customers' responsibility to get the label."
+ ],
+ "type": "string"
+ },
+ "returnReasonCategory": {
+ "description": "The return reason category.",
+ "enum": [
+ "RETURN_REASON_CATEGORY_UNSPECIFIED",
+ "BUYER_REMORSE",
+ "ITEM_DEFECT"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Buyer remorse.",
+ "Item defect."
+ ],
+ "type": "string"
+ },
+ "returnShippingFee": {
+ "$ref": "ReturnPolicyOnlineReturnShippingFee",
+ "description": "The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility."
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyOnlineReturnShippingFee": {
+ "description": "The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.",
+ "id": "ReturnPolicyOnlineReturnShippingFee",
+ "properties": {
+ "fixedFee": {
+ "$ref": "PriceAmount",
+ "description": "Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set."
+ },
+ "type": {
+ "description": "Type of return shipping fee.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "FIXED",
+ "CUSTOMER_PAYING_ACTUAL_FEE"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The return shipping fee is a fixed value.",
+ "Customer will pay the actual return shipping fee."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicyPolicy": {
+ "id": "ReturnPolicyPolicy",
+ "properties": {
+ "lastReturnDate": {
+ "description": "Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to \"lastReturnDate\". Use this for seasonal overrides only.",
+ "type": "string"
+ },
+ "numberOfDays": {
+ "description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to \"numberOfDaysAfterDelivery\". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Policy type. Use \"lastReturnDate\" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - \"`lastReturnDate`\" - \"`lifetimeReturns`\" - \"`noReturns`\" - \"`numberOfDaysAfterDelivery`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPolicySeasonalOverride": {
+ "id": "ReturnPolicySeasonalOverride",
+ "properties": {
+ "endDate": {
+ "description": "Required. Last day on which the override applies. In ISO 8601 format.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the seasonal override as shown in Merchant Center.",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "ReturnPolicyPolicy",
+ "description": "Required. The policy which is in effect during that time."
+ },
+ "startDate": {
+ "description": "Required. First day on which the override applies. In ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnPricingInfo": {
+ "id": "ReturnPricingInfo",
+ "properties": {
+ "chargeReturnShippingFee": {
+ "description": "Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.",
+ "type": "boolean"
+ },
+ "maxReturnShippingFee": {
+ "$ref": "MonetaryAmount",
+ "description": "Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned."
+ },
+ "refundableItemsTotalAmount": {
+ "$ref": "MonetaryAmount",
+ "description": "Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons."
+ },
+ "refundableShippingAmount": {
+ "$ref": "MonetaryAmount",
+ "description": "Maximum amount that can be refunded for the original shipping fee."
+ },
+ "totalRefundedAmount": {
+ "$ref": "MonetaryAmount",
+ "description": "Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet."
+ }
+ },
+ "type": "object"
+ },
+ "ReturnShipment": {
+ "id": "ReturnShipment",
+ "properties": {
+ "creationDate": {
+ "description": "The date of creation of the shipment, in ISO 8601 format.",
+ "type": "string"
+ },
+ "deliveryDate": {
+ "description": "The date of delivery of the shipment, in ISO 8601 format.",
+ "type": "string"
+ },
+ "returnMethodType": {
+ "description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" - \"`inStore`\" ",
+ "type": "string"
+ },
+ "shipmentId": {
+ "description": "Shipment ID generated by Google.",
+ "type": "string"
+ },
+ "shipmentTrackingInfos": {
+ "description": "Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.",
+ "items": {
+ "$ref": "ShipmentTrackingInfo"
+ },
+ "type": "array"
+ },
+ "shippingDate": {
+ "description": "The date of shipping of the shipment, in ISO 8601 format.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnShippingLabel": {
+ "description": "Return shipping label for a Buy on Google merchant-managed return.",
+ "id": "ReturnShippingLabel",
+ "properties": {
+ "carrier": {
+ "description": "Name of the carrier.",
+ "type": "string"
+ },
+ "labelUri": {
+ "description": "The URL for the return shipping label in PDF format",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "The tracking id of this return label.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnaddressCustomBatchRequest": {
+ "id": "ReturnaddressCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "ReturnaddressCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnaddressCustomBatchRequestEntry": {
+ "id": "ReturnaddressCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The Merchant Center account ID.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
+ "type": "string"
+ },
+ "returnAddress": {
+ "$ref": "ReturnAddress",
+ "description": "The return address to submit. This should be set only if the method is `insert`."
+ },
+ "returnAddressId": {
+ "description": "The return address ID. This should be set only if the method is `delete` or `get`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnaddressCustomBatchResponse": {
+ "id": "ReturnaddressCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ReturnaddressCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnaddressCustomBatchResponseEntry": {
+ "id": "ReturnaddressCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "returnAddress": {
+ "$ref": "ReturnAddress",
+ "description": "The retrieved return address."
+ }
+ },
+ "type": "object"
+ },
+ "ReturnaddressListResponse": {
+ "id": "ReturnaddressListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of addresses.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "ReturnAddress"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnpolicyCustomBatchRequest": {
+ "id": "ReturnpolicyCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "ReturnpolicyCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnpolicyCustomBatchRequestEntry": {
+ "id": "ReturnpolicyCustomBatchRequestEntry",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The Merchant Center account ID.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
+ "type": "string"
+ },
+ "returnPolicy": {
+ "$ref": "ReturnPolicy",
+ "description": "The return policy to submit. This should be set only if the method is `insert`."
+ },
+ "returnPolicyId": {
+ "description": "The return policy ID. This should be set only if the method is `delete` or `get`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnpolicyCustomBatchResponse": {
+ "id": "ReturnpolicyCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ReturnpolicyCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnpolicyCustomBatchResponseEntry": {
+ "id": "ReturnpolicyCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnpolicyCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "returnPolicy": {
+ "$ref": "ReturnPolicy",
+ "description": "The retrieved return policy."
+ }
+ },
+ "type": "object"
+ },
+ "ReturnpolicyListResponse": {
+ "id": "ReturnpolicyListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyListResponse\".",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "ReturnPolicy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Row": {
+ "id": "Row",
+ "properties": {
+ "cells": {
+ "description": "The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.",
+ "items": {
+ "$ref": "Value"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SearchRequest": {
+ "description": "Request message for the ReportService.Search method.",
+ "id": "SearchRequest",
+ "properties": {
+ "pageSize": {
+ "description": "Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.",
+ "type": "string"
+ },
+ "query": {
+ "description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SearchResponse": {
+ "description": "Response message for the ReportService.Search method.",
+ "id": "SearchResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "results": {
+ "description": "Rows that matched the search query.",
+ "items": {
+ "$ref": "ReportRow"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Segments": {
+ "description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.",
+ "id": "Segments",
+ "properties": {
+ "date": {
+ "$ref": "Date",
+ "description": "Date in the merchant timezone to which metrics apply."
+ },
+ "offerId": {
+ "description": "Merchant-provided id of the product.",
+ "type": "string"
+ },
+ "program": {
+ "description": "Program to which metrics apply, e.g., Free Product Listing.",
+ "enum": [
+ "PROGRAM_UNSPECIFIED",
+ "SHOPPING_ADS",
+ "FREE_PRODUCT_LISTING",
+ "FREE_LOCAL_PRODUCT_LISTING",
+ "BUY_ON_GOOGLE_LISTING"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Shopping Ads.",
+ "Free Product Listing.",
+ "Free Local Product Listing.",
+ "Buy on Google Listing."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Service": {
+ "id": "Service",
+ "properties": {
+ "active": {
+ "description": "A boolean exposing the active status of the shipping service. Required.",
+ "type": "boolean"
+ },
+ "currency": {
+ "description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.",
+ "type": "string"
+ },
+ "deliveryCountry": {
+ "description": "The CLDR territory code of the country to which the service applies. Required.",
+ "type": "string"
+ },
+ "deliveryTime": {
+ "$ref": "DeliveryTime",
+ "description": "Time spent in various aspects from order to the delivery of the product. Required."
+ },
+ "eligibility": {
+ "description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
+ "type": "string"
+ },
+ "minimumOrderValue": {
+ "$ref": "Price",
+ "description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table."
+ },
+ "minimumOrderValueTable": {
+ "$ref": "MinimumOrderValueTable",
+ "description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value."
+ },
+ "name": {
+ "description": "Free-form name of the service. Must be unique within target account. Required.",
+ "type": "string"
+ },
+ "pickupService": {
+ "$ref": "PickupCarrierService",
+ "description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`."
+ },
+ "rateGroups": {
+ "description": "Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means \"everything else\". The other `applicableShippingLabels` must not overlap.",
+ "items": {
+ "$ref": "RateGroup"
+ },
+ "type": "array"
+ },
+ "shipmentType": {
+ "description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementReport": {
+ "description": " Settlement reports detail order-level and item-level credits and debits between you and Google.",
+ "id": "SettlementReport",
+ "properties": {
+ "endDate": {
+ "description": "The end date on which all transactions are included in the report, in ISO 8601 format.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementReport`\"",
+ "type": "string"
+ },
+ "previousBalance": {
+ "$ref": "Price",
+ "description": "The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance."
+ },
+ "settlementId": {
+ "description": "The ID of the settlement report.",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "The start date on which all transactions are included in the report, in ISO 8601 format.",
+ "type": "string"
+ },
+ "transferAmount": {
+ "$ref": "Price",
+ "description": "The money due to the merchant."
+ },
+ "transferDate": {
+ "description": "Date on which transfer for this payment was initiated by Google, in ISO 8601 format.",
+ "type": "string"
+ },
+ "transferIds": {
+ "description": "The list of bank identifiers used for the transfer. e.g. Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementTransaction": {
+ "description": "Settlement transactions give a detailed breakdown of the settlement report.",
+ "id": "SettlementTransaction",
+ "properties": {
+ "amount": {
+ "$ref": "SettlementTransactionAmount",
+ "description": "The amount for the transaction."
+ },
+ "identifiers": {
+ "$ref": "SettlementTransactionIdentifiers",
+ "description": "Identifiers of the transaction."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\"",
+ "type": "string"
+ },
+ "transaction": {
+ "$ref": "SettlementTransactionTransaction",
+ "description": "Details of the transaction."
+ }
+ },
+ "type": "object"
+ },
+ "SettlementTransactionAmount": {
+ "id": "SettlementTransactionAmount",
+ "properties": {
+ "commission": {
+ "$ref": "SettlementTransactionAmountCommission"
+ },
+ "description": {
+ "description": "The description of the event. Acceptable values are: - \"`taxWithhold`\" - \"`principal`\" - \"`principalAdjustment`\" - \"`shippingFee`\" - \"`merchantRemittedSalesTax`\" - \"`googleRemittedSalesTax`\" - \"`merchantCoupon`\" - \"`merchantCouponTax`\" - \"`merchantRemittedDisposalTax`\" - \"`googleRemittedDisposalTax`\" - \"`merchantRemittedRedemptionFee`\" - \"`googleRemittedRedemptionFee`\" - \"`eeeEcoFee`\" - \"`furnitureEcoFee`\" - \"`copyPrivateFee`\" - \"`eeeEcoFeeCommission`\" - \"`furnitureEcoFeeCommission`\" - \"`copyPrivateFeeCommission`\" - \"`principalRefund`\" - \"`principalRefundTax`\" - \"`itemCommission`\" - \"`adjustmentCommission`\" - \"`shippingFeeCommission`\" - \"`commissionRefund`\" - \"`damaged`\" - \"`damagedOrDefectiveItem`\" - \"`expiredItem`\" - \"`faultyItem`\" - \"`incorrectItemReceived`\" - \"`itemMissing`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`storePackageMissing`\" - \"`transitPackageMissing`\" - \"`unsuccessfulDeliveryUndeliverable`\" - \"`wrongChargeInStore`\" - \"`wrongItem`\" - \"`returns`\" - \"`undeliverable`\" - \"`issueRelatedRefundAndReplacementAmountDescription`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" - \"`lumpSumCorrection`\" - \"`pspFee`\" - \"`principalRefundDoesNotFit`\" - \"`principalRefundOrderedWrongItem`\" - \"`principalRefundQualityNotExpected`\" - \"`principalRefundBetterPriceFound`\" - \"`principalRefundNoLongerNeeded`\" - \"`principalRefundChangedMind`\" - \"`principalRefundReceivedTooLate`\" - \"`principalRefundIncorrectItemReceived`\" - \"`principalRefundDamagedOrDefectiveItem`\" - \"`principalRefundDidNotMatchDescription`\" - \"`principalRefundExpiredItem`\" ",
+ "type": "string"
+ },
+ "transactionAmount": {
+ "$ref": "Price",
+ "description": "The amount that contributes to the line item price."
+ },
+ "type": {
+ "description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" - \"`lumpSumCorrectionAmount`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementTransactionAmountCommission": {
+ "id": "SettlementTransactionAmountCommission",
+ "properties": {
+ "category": {
+ "description": "The category of the commission. Acceptable values are: - \"`animalsAndPetSupplies`\" - \"`dogCatFoodAndCatLitter`\" - \"`apparelAndAccessories`\" - \"`shoesHandbagsAndSunglasses`\" - \"`costumesAndAccessories`\" - \"`jewelry`\" - \"`watches`\" - \"`hobbiesArtsAndCrafts`\" - \"`homeAndGarden`\" - \"`entertainmentCollectibles`\" - \"`collectibleCoins`\" - \"`sportsCollectibles`\" - \"`sportingGoods`\" - \"`toysAndGames`\" - \"`musicalInstruments`\" - \"`giftCards`\" - \"`babyAndToddler`\" - \"`babyFoodWipesAndDiapers`\" - \"`businessAndIndustrial`\" - \"`camerasOpticsAndPhotography`\" - \"`consumerElectronics`\" - \"`electronicsAccessories`\" - \"`personalComputers`\" - \"`videoGameConsoles`\" - \"`foodAndGrocery`\" - \"`beverages`\" - \"`tobaccoProducts`\" - \"`furniture`\" - \"`hardware`\" - \"`buildingMaterials`\" - \"`tools`\" - \"`healthAndPersonalCare`\" - \"`beauty`\" - \"`householdSupplies`\" - \"`kitchenAndDining`\" - \"`majorAppliances`\" - \"`luggageAndBags`\" - \"`media`\" - \"`officeSupplies`\" - \"`softwareAndVideoGames`\" - \"`vehiclePartsAndAccessories`\" - \"`vehicleTiresAndWheels`\" - \"`vehicles`\" - \"`everythingElse`\" ",
+ "type": "string"
+ },
+ "rate": {
+ "description": "Rate of the commission in percentage.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementTransactionIdentifiers": {
+ "id": "SettlementTransactionIdentifiers",
+ "properties": {
+ "adjustmentId": {
+ "description": "The identifier of the adjustments, if it is available.",
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "description": "The merchant provided order ID.",
+ "type": "string"
+ },
+ "orderItemId": {
+ "description": "The identifier of the item.",
+ "type": "string"
+ },
+ "settlementEntryId": {
+ "description": "The unique ID of the settlement transaction entry.",
+ "type": "string"
+ },
+ "shipmentIds": {
+ "description": "The shipment ids for the item.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "TestOrderPickupDetailsPickupPerson": {
- "id": "TestOrderPickupDetailsPickupPerson",
- "properties": {
- "name": {
- "description": "Required. Full name of the pickup person.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Required. The phone number of the person picking up the items.",
- "type": "string"
- }
- },
- "type": "object"
+ "transactionId": {
+ "description": "The Google transaction ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementTransactionTransaction": {
+ "id": "SettlementTransactionTransaction",
+ "properties": {
+ "postDate": {
+ "description": "The time on which the event occurred in ISO 8601 format.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" - \"`lumpSumCorrectionTransaction`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementreportsListResponse": {
+ "id": "SettlementreportsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementreportsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of returns.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "SettlementReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SettlementtransactionsListResponse": {
+ "id": "SettlementtransactionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementtransactionsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of returns.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "SettlementTransaction"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ShipmentInvoice": {
+ "id": "ShipmentInvoice",
+ "properties": {
+ "invoiceSummary": {
+ "$ref": "InvoiceSummary",
+ "description": "[required] Invoice summary."
+ },
+ "lineItemInvoices": {
+ "description": "[required] Invoice details per line item.",
+ "items": {
+ "$ref": "ShipmentInvoiceLineItemInvoice"
+ },
+ "type": "array"
+ },
+ "shipmentGroupId": {
+ "description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShipmentInvoiceLineItemInvoice": {
+ "id": "ShipmentInvoiceLineItemInvoice",
+ "properties": {
+ "lineItemId": {
+ "description": "ID of the line item. Either lineItemId or productId must be set.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.",
+ "type": "string"
+ },
+ "shipmentUnitIds": {
+ "description": "[required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "TimeZone": {
- "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
- "id": "TimeZone",
- "properties": {
- "id": {
- "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".",
- "type": "string"
- },
- "version": {
- "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TransitTable": {
- "id": "TransitTable",
- "properties": {
- "postalCodeGroupNames": {
- "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "rows": {
- "items": {
- "$ref": "TransitTableTransitTimeRow"
- },
- "type": "array"
- },
- "transitTimeLabels": {
- "description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "unitInvoice": {
+ "$ref": "UnitInvoice",
+ "description": "[required] Invoice details for a single unit."
+ }
+ },
+ "type": "object"
+ },
+ "ShipmentTrackingInfo": {
+ "id": "ShipmentTrackingInfo",
+ "properties": {
+ "carrier": {
+ "description": "The shipping carrier that handles the package. Acceptable values are: - \"`boxtal`\" - \"`bpost`\" - \"`chronopost`\" - \"`colisPrive`\" - \"`colissimo`\" - \"`cxt`\" - \"`deliv`\" - \"`dhl`\" - \"`dpd`\" - \"`dynamex`\" - \"`eCourier`\" - \"`easypost`\" - \"`efw`\" - \"`fedex`\" - \"`fedexSmartpost`\" - \"`geodis`\" - \"`gls`\" - \"`googleCourier`\" - \"`gsx`\" - \"`jdLogistics`\" - \"`laPoste`\" - \"`lasership`\" - \"`manual`\" - \"`mpx`\" - \"`onTrac`\" - \"`other`\" - \"`tnt`\" - \"`uds`\" - \"`ups`\" - \"`usps`\" ",
+ "type": "string"
+ },
+ "trackingNumber": {
+ "description": "The tracking number for the package.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingSettings": {
+ "description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
+ "id": "ShippingSettings",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "postalCodeGroups": {
+ "description": "A list of postal code groups that can be referred to in `services`. Optional.",
+ "items": {
+ "$ref": "PostalCodeGroup"
+ },
+ "type": "array"
+ },
+ "services": {
+ "description": "The target account's list of services. Optional.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsCustomBatchRequest": {
+ "id": "ShippingsettingsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "ShippingsettingsCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch shippingsettings request.",
+ "id": "ShippingsettingsCustomBatchRequestEntry",
+ "properties": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account shipping settings.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
+ "type": "string"
+ },
+ "shippingSettings": {
+ "$ref": "ShippingSettings",
+ "description": "The account shipping settings to update. Only defined if the method is `update`."
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsCustomBatchResponse": {
+ "id": "ShippingsettingsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ShippingsettingsCustomBatchResponseEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch shipping settings response.",
+ "id": "ShippingsettingsCustomBatchResponseEntry",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "shippingSettings": {
+ "$ref": "ShippingSettings",
+ "description": "The retrieved or updated account shipping settings."
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsGetSupportedCarriersResponse": {
+ "id": "ShippingsettingsGetSupportedCarriersResponse",
+ "properties": {
+ "carriers": {
+ "description": "A list of supported carriers. May be empty.",
+ "items": {
+ "$ref": "CarriersCarrier"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsGetSupportedHolidaysResponse": {
+ "id": "ShippingsettingsGetSupportedHolidaysResponse",
+ "properties": {
+ "holidays": {
+ "description": "A list of holidays applicable for delivery guarantees. May be empty.",
+ "items": {
+ "$ref": "HolidaysHoliday"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsGetSupportedPickupServicesResponse": {
+ "id": "ShippingsettingsGetSupportedPickupServicesResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\".",
+ "type": "string"
+ },
+ "pickupServices": {
+ "description": "A list of supported pickup services. May be empty.",
+ "items": {
+ "$ref": "PickupServicesPickupService"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsListResponse": {
+ "id": "ShippingsettingsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of shipping settings.",
+ "type": "string"
+ },
+ "resources": {
+ "items": {
+ "$ref": "ShippingSettings"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Table": {
+ "id": "Table",
+ "properties": {
+ "columnHeaders": {
+ "$ref": "Headers",
+ "description": "Headers of the table's columns. Optional: if not set then the table has only one dimension."
+ },
+ "name": {
+ "description": "Name of the table. Required for subtables, ignored for the main table.",
+ "type": "string"
+ },
+ "rowHeaders": {
+ "$ref": "Headers",
+ "description": "Headers of the table's rows. Required."
+ },
+ "rows": {
+ "description": "The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.",
+ "items": {
+ "$ref": "Row"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrder": {
+ "id": "TestOrder",
+ "properties": {
+ "deliveryDetails": {
+ "$ref": "TestOrderDeliveryDetails",
+ "description": "Overrides the predefined delivery details if provided."
+ },
+ "enableOrderinvoices": {
+ "description": "Whether the orderinvoices service should support this order.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\"",
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "Required. Line items that are ordered. At least one line item must be provided.",
+ "items": {
+ "$ref": "TestOrderLineItem"
+ },
+ "type": "array"
+ },
+ "notificationMode": {
+ "description": "Restricted. Do not use.",
+ "type": "string"
+ },
+ "pickupDetails": {
+ "$ref": "TestOrderPickupDetails",
+ "description": "Overrides the predefined pickup details if provided."
+ },
+ "predefinedBillingAddress": {
+ "description": "Required. The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
+ "type": "string"
+ },
+ "predefinedDeliveryAddress": {
+ "description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
+ "type": "string"
+ },
+ "predefinedEmail": {
+ "description": "Required. Email address of the customer. Acceptable values are: - \"`pog.dwight.schrute@gmail.com`\" - \"`pog.jim.halpert@gmail.com`\" - \"`penpog.pam.beesly@gmail.comding`\" ",
+ "type": "string"
+ },
+ "predefinedPickupDetails": {
+ "description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
+ "type": "string"
+ },
+ "promotions": {
+ "description": "Promotions associated with the order.",
+ "items": {
+ "$ref": "OrderPromotion"
+ },
+ "type": "array"
+ },
+ "shippingCost": {
+ "$ref": "Price",
+ "description": "Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states."
+ },
+ "shippingOption": {
+ "description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderAddress": {
+ "id": "TestOrderAddress",
+ "properties": {
+ "country": {
+ "description": "CLDR country code (e.g. \"US\").",
+ "type": "string"
+ },
+ "fullAddress": {
+ "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "TransitTableTransitTimeRow": {
- "id": "TransitTableTransitTimeRow",
- "properties": {
- "values": {
- "items": {
- "$ref": "TransitTableTransitTimeRowTransitTimeValue"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "isPostOfficeBox": {
+ "description": "Whether the address is a post office box.",
+ "type": "boolean"
},
- "TransitTableTransitTimeRowTransitTimeValue": {
- "id": "TransitTableTransitTimeRowTransitTimeValue",
- "properties": {
- "maxTransitTimeInDays": {
- "description": "Must be greater than or equal to `minTransitTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "minTransitTimeInDays": {
- "description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "UnitInvoice": {
- "id": "UnitInvoice",
- "properties": {
- "additionalCharges": {
- "description": "Additional charges for a unit, e.g. shipping costs.",
- "items": {
- "$ref": "UnitInvoiceAdditionalCharge"
- },
- "type": "array"
- },
- "unitPrice": {
- "$ref": "Price",
- "description": "[required] Pre-tax or post-tax price of the unit depending on the locality of the order."
- },
- "unitPriceTaxes": {
- "description": "Tax amounts to apply to the unit price.",
- "items": {
- "$ref": "UnitInvoiceTaxLine"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "locality": {
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
+ "type": "string"
},
- "UnitInvoiceAdditionalCharge": {
- "id": "UnitInvoiceAdditionalCharge",
- "properties": {
- "additionalChargeAmount": {
- "$ref": "Amount",
- "description": "[required] Amount of the additional charge."
- },
- "type": {
- "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "postalCode": {
+ "description": "Postal Code or ZIP (e.g. \"94043\").",
+ "type": "string"
},
- "UnitInvoiceTaxLine": {
- "id": "UnitInvoiceTaxLine",
- "properties": {
- "taxAmount": {
- "$ref": "Price",
- "description": "[required] Tax amount for the tax type."
- },
- "taxName": {
- "description": "Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.",
- "type": "string"
- },
- "taxType": {
- "description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" ",
- "type": "string"
- }
- },
- "type": "object"
+ "recipientName": {
+ "description": "Name of the recipient.",
+ "type": "string"
},
- "Value": {
- "description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.",
- "id": "Value",
- "properties": {
- "carrierRateName": {
- "description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.",
- "type": "string"
- },
- "flatRate": {
- "$ref": "Price",
- "description": "A flat rate. Can only be set if all other fields are not set."
- },
- "noShipping": {
- "description": "If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.",
- "type": "boolean"
- },
- "pricePercentage": {
- "description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set.",
- "type": "string"
- },
- "subtableName": {
- "description": "The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.",
- "type": "string"
- }
- },
- "type": "object"
+ "region": {
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
+ "type": "string"
},
- "Weight": {
- "id": "Weight",
- "properties": {
- "unit": {
- "description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" ",
- "type": "string"
- },
- "value": {
- "description": "Required. The weight represented as a number.",
- "type": "string"
- }
- },
- "type": "object"
+ "streetAddress": {
+ "description": "Street-level part of the address.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderDeliveryDetails": {
+ "id": "TestOrderDeliveryDetails",
+ "properties": {
+ "address": {
+ "$ref": "TestOrderAddress",
+ "description": "The delivery address"
+ },
+ "isScheduledDelivery": {
+ "description": "Whether the order is scheduled delivery order.",
+ "type": "boolean"
+ },
+ "phoneNumber": {
+ "description": "The phone number of the person receiving the delivery.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderLineItem": {
+ "id": "TestOrderLineItem",
+ "properties": {
+ "product": {
+ "$ref": "TestOrderLineItemProduct",
+ "description": "Required. Product data from the time of the order placement."
+ },
+ "quantityOrdered": {
+ "description": "Required. Number of items ordered.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "returnInfo": {
+ "$ref": "OrderLineItemReturnInfo",
+ "description": "Required. Details of the return policy for the line item."
+ },
+ "shippingDetails": {
+ "$ref": "OrderLineItemShippingDetails",
+ "description": "Required. Details of the requested shipping for the line item."
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderLineItemProduct": {
+ "id": "TestOrderLineItemProduct",
+ "properties": {
+ "brand": {
+ "description": "Required. Brand of the item.",
+ "type": "string"
+ },
+ "condition": {
+ "description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" ",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" ",
+ "type": "string"
+ },
+ "fees": {
+ "description": "Fees for the item. Optional.",
+ "items": {
+ "$ref": "OrderLineItemProductFee"
+ },
+ "type": "array"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item. Optional.",
+ "type": "string"
+ },
+ "imageLink": {
+ "description": "Required. URL of an image of the item.",
+ "type": "string"
+ },
+ "itemGroupId": {
+ "description": "Shared identifier for all variants of the same product. Optional.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "Manufacturer Part Number (MPN) of the item. Optional.",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "Required. An identifier of the item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied."
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory // code of the target country of the product.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Required. The title of the product.",
+ "type": "string"
+ },
+ "variantAttributes": {
+ "description": "Variant attributes for the item. Optional.",
+ "items": {
+ "$ref": "OrderLineItemProductVariantAttribute"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderPickupDetails": {
+ "id": "TestOrderPickupDetails",
+ "properties": {
+ "locationCode": {
+ "description": "Required. Code of the location defined by provider or merchant.",
+ "type": "string"
+ },
+ "pickupLocationAddress": {
+ "$ref": "TestOrderAddress",
+ "description": "Required. Pickup location address."
+ },
+ "pickupLocationType": {
+ "description": "Pickup location type. Acceptable values are: - \"`locker`\" - \"`store`\" - \"`curbside`\" ",
+ "type": "string"
+ },
+ "pickupPersons": {
+ "description": "Required. all pickup persons set by users.",
+ "items": {
+ "$ref": "TestOrderPickupDetailsPickupPerson"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestOrderPickupDetailsPickupPerson": {
+ "id": "TestOrderPickupDetailsPickupPerson",
+ "properties": {
+ "name": {
+ "description": "Required. Full name of the pickup person.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Required. The phone number of the person picking up the items.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimeZone": {
+ "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
+ "id": "TimeZone",
+ "properties": {
+ "id": {
+ "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TransitTable": {
+ "id": "TransitTable",
+ "properties": {
+ "postalCodeGroupNames": {
+ "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "rows": {
+ "items": {
+ "$ref": "TransitTableTransitTimeRow"
+ },
+ "type": "array"
+ },
+ "transitTimeLabels": {
+ "description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TransitTableTransitTimeRow": {
+ "id": "TransitTableTransitTimeRow",
+ "properties": {
+ "values": {
+ "items": {
+ "$ref": "TransitTableTransitTimeRowTransitTimeValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TransitTableTransitTimeRowTransitTimeValue": {
+ "id": "TransitTableTransitTimeRowTransitTimeValue",
+ "properties": {
+ "maxTransitTimeInDays": {
+ "description": "Must be greater than or equal to `minTransitTimeInDays`.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "minTransitTimeInDays": {
+ "description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UnitInvoice": {
+ "id": "UnitInvoice",
+ "properties": {
+ "additionalCharges": {
+ "description": "Additional charges for a unit, e.g. shipping costs.",
+ "items": {
+ "$ref": "UnitInvoiceAdditionalCharge"
+ },
+ "type": "array"
+ },
+ "unitPrice": {
+ "$ref": "Price",
+ "description": "[required] Pre-tax or post-tax price of the unit depending on the locality of the order."
+ },
+ "unitPriceTaxes": {
+ "description": "Tax amounts to apply to the unit price.",
+ "items": {
+ "$ref": "UnitInvoiceTaxLine"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UnitInvoiceAdditionalCharge": {
+ "id": "UnitInvoiceAdditionalCharge",
+ "properties": {
+ "additionalChargeAmount": {
+ "$ref": "Amount",
+ "description": "[required] Amount of the additional charge."
+ },
+ "type": {
+ "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UnitInvoiceTaxLine": {
+ "id": "UnitInvoiceTaxLine",
+ "properties": {
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "[required] Tax amount for the tax type."
+ },
+ "taxName": {
+ "description": "Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.",
+ "type": "string"
+ },
+ "taxType": {
+ "description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Value": {
+ "description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.",
+ "id": "Value",
+ "properties": {
+ "carrierRateName": {
+ "description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.",
+ "type": "string"
+ },
+ "flatRate": {
+ "$ref": "Price",
+ "description": "A flat rate. Can only be set if all other fields are not set."
+ },
+ "noShipping": {
+ "description": "If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.",
+ "type": "boolean"
+ },
+ "pricePercentage": {
+ "description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set.",
+ "type": "string"
+ },
+ "subtableName": {
+ "description": "The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "WarehouseBasedDeliveryTime": {
+ "id": "WarehouseBasedDeliveryTime",
+ "properties": {
+ "carrier": {
+ "description": "Required. Carrier, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.",
+ "type": "string"
+ },
+ "carrierService": {
+ "description": "Required. Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.",
+ "type": "string"
+ },
+ "originAdministrativeArea": {
+ "description": "Required. Shipping origin's state.",
+ "type": "string"
+ },
+ "originCity": {
+ "description": "Required. Shipping origin's city.",
+ "type": "string"
+ },
+ "originCountry": {
+ "description": "Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).",
+ "type": "string"
+ },
+ "originPostalCode": {
+ "description": "Required. Shipping origin.",
+ "type": "string"
+ },
+ "originStreetAddress": {
+ "description": "Shipping origin's street address.",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "content/v2.1/",
- "title": "Content API for Shopping",
- "version": "v2.1"
+ "Weight": {
+ "id": "Weight",
+ "properties": {
+ "unit": {
+ "description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" ",
+ "type": "string"
+ },
+ "value": {
+ "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "content/v2.1/",
+ "title": "Content API for Shopping",
+ "version": "v2.1"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json
index 25cace5d536..b62d4ead86c 100644
--- a/googleapiclient/discovery_cache/documents/customsearch.v1.json
+++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json
@@ -674,7 +674,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://customsearch.googleapis.com/",
"schemas": {
"Promotion": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json
index 726a2d831aa..2261cc16e93 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1.json
@@ -625,7 +625,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210517",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
index 5a470f59091..9be8b5b7335 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
@@ -167,7 +167,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210517",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"GoogleDatastoreAdminV1CommonMetadata": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
index c79213e8457..dfef9b5b8ca 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
@@ -307,7 +307,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210517",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v3.3.json b/googleapiclient/discovery_cache/documents/dfareporting.v3.3.json
index e7b0303acfd..2f7f27ca732 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v3.3.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v3.3.json
@@ -1,19967 +1,19972 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/ddmconversions": {
- "description": "Manage DoubleClick Digital Marketing conversions"
- },
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- },
- "https://www.googleapis.com/auth/dfatrafficking": {
- "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
- }
- }
- }
- },
- "basePath": "/dfareporting/v3.3/",
- "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.3/",
- "batchPath": "batch",
- "canonicalName": "Dfareporting",
- "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
- "discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "dfareporting:v3.3",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
- "name": "dfareporting",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/ddmconversions": {
+ "description": "Manage DoubleClick Digital Marketing conversions"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/dfareporting": {
+ "description": "View and manage DoubleClick for Advertisers reports"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/dfatrafficking": {
+ "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
}
+ }
+ }
+ },
+ "basePath": "/dfareporting/v3.3/",
+ "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.3/",
+ "batchPath": "batch",
+ "canonicalName": "Dfareporting",
+ "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "dfareporting:v3.3",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
+ "name": "dfareporting",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "protocol": "rest",
- "resources": {
- "accountActiveAdSummaries": {
- "methods": {
- "get": {
- "description": "Gets the account's active ad summary by account ID.",
- "flatPath": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "httpMethod": "GET",
- "id": "dfareporting.accountActiveAdSummaries.get",
- "parameterOrder": [
- "profileId",
- "summaryAccountId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "summaryAccountId": {
- "description": "Account ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "response": {
- "$ref": "AccountActiveAdSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accountActiveAdSummaries": {
+ "methods": {
+ "get": {
+ "description": "Gets the account's active ad summary by account ID.",
+ "flatPath": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountActiveAdSummaries.get",
+ "parameterOrder": [
+ "profileId",
+ "summaryAccountId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "summaryAccountId": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountPermissionGroups": {
- "methods": {
- "get": {
- "description": "Gets one account permission group by ID.",
- "flatPath": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissionGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account permission group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "response": {
- "$ref": "AccountPermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of account permission groups.",
- "flatPath": "userprofiles/{profileId}/accountPermissionGroups",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissionGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissionGroups",
- "response": {
- "$ref": "AccountPermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "response": {
+ "$ref": "AccountActiveAdSummary"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission group by ID.",
+ "flatPath": "userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountPermissions": {
- "methods": {
- "get": {
- "description": "Gets one account permission by ID.",
- "flatPath": "userprofiles/{profileId}/accountPermissions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account permission ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissions/{id}",
- "response": {
- "$ref": "AccountPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of account permissions.",
- "flatPath": "userprofiles/{profileId}/accountPermissions",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissions",
- "response": {
- "$ref": "AccountPermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "response": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permission groups.",
+ "flatPath": "userprofiles/{profileId}/accountPermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountUserProfiles": {
- "methods": {
- "get": {
- "description": "Gets one account user profile by ID.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountUserProfiles.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new account user profile.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "POST",
- "id": "dfareporting.accountUserProfiles.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "GET",
- "id": "dfareporting.accountUserProfiles.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active user profiles.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only user profiles with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only user profiles with the specified subaccount ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "userRoleId": {
- "description": "Select only user profiles with the specified user role ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "response": {
- "$ref": "AccountUserProfilesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing account user profile. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PATCH",
- "id": "dfareporting.accountUserProfiles.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "AccountUserProfile ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing account user profile.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PUT",
- "id": "dfareporting.accountUserProfiles.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissionGroups",
+ "response": {
+ "$ref": "AccountPermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission by ID.",
+ "flatPath": "userprofiles/{profileId}/accountPermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accounts": {
- "methods": {
- "get": {
- "description": "Gets one account by ID.",
- "flatPath": "userprofiles/{profileId}/accounts/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accounts.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts/{id}",
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "GET",
- "id": "dfareporting.accounts.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only accounts with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing account. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "PATCH",
- "id": "dfareporting.accounts.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing account.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "PUT",
- "id": "dfareporting.accounts.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissions/{id}",
+ "response": {
+ "$ref": "AccountPermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permissions.",
+ "flatPath": "userprofiles/{profileId}/accountPermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "ads": {
- "methods": {
- "get": {
- "description": "Gets one ad by ID.",
- "flatPath": "userprofiles/{profileId}/ads/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.ads.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Ad ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads/{id}",
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new ad.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "POST",
- "id": "dfareporting.ads.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "GET",
- "id": "dfareporting.ads.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active ads.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only ads with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "archived": {
- "description": "Select only archived ads.",
- "location": "query",
- "type": "boolean"
- },
- "audienceSegmentIds": {
- "description": "Select only ads with these audience segment IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "campaignIds": {
- "description": "Select only ads with these campaign IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "compatibility": {
- "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "creativeIds": {
- "description": "Select only ads with these creative IDs assigned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "creativeOptimizationConfigurationIds": {
- "description": "Select only ads with these creative optimization configuration IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "dynamicClickTracker": {
- "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only ads with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "landingPageIds": {
- "description": "Select only ads with these landing page IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "overriddenEventTagId": {
- "description": "Select only ads with this event tag override ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "placementIds": {
- "description": "Select only ads with these placement IDs assigned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "remarketingListIds": {
- "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- "location": "query",
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only ads with these size IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sslCompliant": {
- "description": "Select only ads that are SSL-compliant.",
- "location": "query",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Select only ads that require SSL.",
- "location": "query",
- "type": "boolean"
- },
- "type": {
- "description": "Select only ads with these types.",
- "enum": [
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_TRACKING",
- "AD_SERVING_BRAND_SAFE_AD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "response": {
- "$ref": "AdsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing ad. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "PATCH",
- "id": "dfareporting.ads.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Ad ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing ad.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "PUT",
- "id": "dfareporting.ads.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissions",
+ "response": {
+ "$ref": "AccountPermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountUserProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one account user profile by ID.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "advertiserGroups": {
- "methods": {
- "delete": {
- "description": "Deletes an existing advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.advertiserGroups.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one advertiser group by ID.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "POST",
- "id": "dfareporting.advertiserGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only advertiser groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "response": {
- "$ref": "AdvertiserGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertiserGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "AdvertiserGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.advertiserGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new account user profile.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "POST",
+ "id": "dfareporting.accountUserProfiles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "advertiserLandingPages": {
- "methods": {
- "get": {
- "description": "Gets one landing page by ID.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserLandingPages.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Landing page ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages/{id}",
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new landing page.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "POST",
- "id": "dfareporting.advertiserLandingPages.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of landing pages.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserLandingPages.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only landing pages that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only landing pages that are associated with these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only landing pages with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only landing pages that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "response": {
- "$ref": "AdvertiserLandingPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser landing page. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertiserLandingPages.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "LandingPage ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing landing page.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "PUT",
- "id": "dfareporting.advertiserLandingPages.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active user profiles.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user profiles with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user profiles with the specified subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "userRoleId": {
+ "description": "Select only user profiles with the specified user role ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "advertisers": {
- "methods": {
- "get": {
- "description": "Gets one advertiser by ID.",
- "flatPath": "userprofiles/{profileId}/advertisers/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertisers.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers/{id}",
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new advertiser.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "POST",
- "id": "dfareporting.advertisers.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "GET",
- "id": "dfareporting.advertisers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserGroupIds": {
- "description": "Select only advertisers with these advertiser group IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "floodlightConfigurationIds": {
- "description": "Select only advertisers with these floodlight configuration IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only advertisers with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "includeAdvertisersWithoutGroupsOnly": {
- "description": "Select only advertisers which do not belong to any advertiser group.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "onlyParent": {
- "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- "location": "query",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "status": {
- "description": "Select only advertisers with the specified status.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only advertisers with these subaccount IDs.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "response": {
- "$ref": "AdvertisersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertisers.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing advertiser.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PUT",
- "id": "dfareporting.advertisers.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "response": {
+ "$ref": "AccountUserProfilesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account user profile. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accountUserProfiles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AccountUserProfile ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "browsers": {
- "methods": {
- "list": {
- "description": "Retrieves a list of browsers.",
- "flatPath": "userprofiles/{profileId}/browsers",
- "httpMethod": "GET",
- "id": "dfareporting.browsers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/browsers",
- "response": {
- "$ref": "BrowsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account user profile.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accountUserProfiles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "campaignCreativeAssociations": {
- "methods": {
- "insert": {
- "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "POST",
- "id": "dfareporting.campaignCreativeAssociations.insert",
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Campaign ID in this association.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "request": {
- "$ref": "CampaignCreativeAssociation"
- },
- "response": {
- "$ref": "CampaignCreativeAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "GET",
- "id": "dfareporting.campaignCreativeAssociations.list",
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Campaign ID in this association.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "response": {
- "$ref": "CampaignCreativeAssociationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "flatPath": "userprofiles/{profileId}/accounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "campaigns": {
- "methods": {
- "get": {
- "description": "Gets one campaign by ID.",
- "flatPath": "userprofiles/{profileId}/campaigns/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.campaigns.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Campaign ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{id}",
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new campaign.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "POST",
- "id": "dfareporting.campaigns.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "GET",
- "id": "dfareporting.campaigns.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserGroupIds": {
- "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "advertiserIds": {
- "description": "Select only campaigns that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- "location": "query",
- "type": "boolean"
- },
- "atLeastOneOptimizationActivity": {
- "description": "Select only campaigns that have at least one optimization activity.",
- "location": "query",
- "type": "boolean"
- },
- "excludedIds": {
- "description": "Exclude campaigns with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only campaigns with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "overriddenEventTagId": {
- "description": "Select only campaigns that have overridden this event tag ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only campaigns that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "response": {
- "$ref": "CampaignsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing campaign. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PATCH",
- "id": "dfareporting.campaigns.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Campaign ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing campaign.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PUT",
- "id": "dfareporting.campaigns.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only accounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "changeLogs": {
- "methods": {
- "get": {
- "description": "Gets one change log by ID.",
- "flatPath": "userprofiles/{profileId}/changeLogs/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.changeLogs.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Change log ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/changeLogs/{id}",
- "response": {
- "$ref": "ChangeLog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of change logs. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/changeLogs",
- "httpMethod": "GET",
- "id": "dfareporting.changeLogs.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "action": {
- "description": "Select only change logs with the specified action.",
- "enum": [
- "ACTION_CREATE",
- "ACTION_UPDATE",
- "ACTION_DELETE",
- "ACTION_ENABLE",
- "ACTION_DISABLE",
- "ACTION_ADD",
- "ACTION_REMOVE",
- "ACTION_MARK_AS_DEFAULT",
- "ACTION_ASSOCIATE",
- "ACTION_ASSIGN",
- "ACTION_UNASSIGN",
- "ACTION_SEND",
- "ACTION_LINK",
- "ACTION_UNLINK",
- "ACTION_PUSH",
- "ACTION_EMAIL_TAGS",
- "ACTION_SHARE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only change logs with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxChangeTime": {
- "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "minChangeTime": {
- "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query",
- "type": "string"
- },
- "objectIds": {
- "description": "Select only change logs with these object IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "objectType": {
- "description": "Select only change logs with the specified object type.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_FLOODLIGHT_CONFIGURATION",
- "OBJECT_AD",
- "OBJECT_FLOODLIGHT_ACTVITY",
- "OBJECT_CAMPAIGN",
- "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT",
- "OBJECT_DFA_SITE",
- "OBJECT_USER_ROLE",
- "OBJECT_USER_PROFILE",
- "OBJECT_ADVERTISER_GROUP",
- "OBJECT_ACCOUNT",
- "OBJECT_SUBACCOUNT",
- "OBJECT_RICHMEDIA_CREATIVE",
- "OBJECT_INSTREAM_CREATIVE",
- "OBJECT_MEDIA_ORDER",
- "OBJECT_CONTENT_CATEGORY",
- "OBJECT_PLACEMENT_STRATEGY",
- "OBJECT_SD_SITE",
- "OBJECT_SIZE",
- "OBJECT_CREATIVE_GROUP",
- "OBJECT_CREATIVE_ASSET",
- "OBJECT_USER_PROFILE_FILTER",
- "OBJECT_LANDING_PAGE",
- "OBJECT_CREATIVE_FIELD",
- "OBJECT_REMARKETING_LIST",
- "OBJECT_PROVIDED_LIST_CLIENT",
- "OBJECT_EVENT_TAG",
- "OBJECT_CREATIVE_BUNDLE",
- "OBJECT_BILLING_ACCOUNT_GROUP",
- "OBJECT_BILLING_FEATURE",
- "OBJECT_RATE_CARD",
- "OBJECT_ACCOUNT_BILLING_FEATURE",
- "OBJECT_BILLING_MINIMUM_FEE",
- "OBJECT_BILLING_PROFILE",
- "OBJECT_PLAYSTORE_LINK",
- "OBJECT_TARGETING_TEMPLATE",
- "OBJECT_SEARCH_LIFT_STUDY",
- "OBJECT_FLOODLIGHT_DV360_LINK"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- "location": "query",
- "type": "string"
- },
- "userProfileIds": {
- "description": "Select only change logs with these user profile IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/changeLogs",
- "response": {
- "$ref": "ChangeLogsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "response": {
+ "$ref": "AccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "cities": {
- "methods": {
- "list": {
- "description": "Retrieves a list of cities, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/cities",
- "httpMethod": "GET",
- "id": "dfareporting.cities.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "countryDartIds": {
- "description": "Select only cities from these countries.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "dartIds": {
- "description": "Select only cities with these DART IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "namePrefix": {
- "description": "Select only cities with names starting with this prefix.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionDartIds": {
- "description": "Select only cities from these regions.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/cities",
- "response": {
- "$ref": "CitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "connectionTypes": {
- "methods": {
- "get": {
- "description": "Gets one connection type by ID.",
- "flatPath": "userprofiles/{profileId}/connectionTypes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.connectionTypes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Connection type ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/connectionTypes/{id}",
- "response": {
- "$ref": "ConnectionType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of connection types.",
- "flatPath": "userprofiles/{profileId}/connectionTypes",
- "httpMethod": "GET",
- "id": "dfareporting.connectionTypes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/connectionTypes",
- "response": {
- "$ref": "ConnectionTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "ads": {
+ "methods": {
+ "get": {
+ "description": "Gets one ad by ID.",
+ "flatPath": "userprofiles/{profileId}/ads/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "contentCategories": {
- "methods": {
- "delete": {
- "description": "Deletes an existing content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.contentCategories.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Content category ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one content category by ID.",
- "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.contentCategories.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Content category ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "POST",
- "id": "dfareporting.contentCategories.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "GET",
- "id": "dfareporting.contentCategories.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only content categories with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "response": {
- "$ref": "ContentCategoriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing content category. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PATCH",
- "id": "dfareporting.contentCategories.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "ContentCategory ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PUT",
- "id": "dfareporting.contentCategories.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads/{id}",
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new ad.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "POST",
+ "id": "dfareporting.ads.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "conversions": {
- "methods": {
- "batchinsert": {
- "description": "Inserts conversions.",
- "flatPath": "userprofiles/{profileId}/conversions/batchinsert",
- "httpMethod": "POST",
- "id": "dfareporting.conversions.batchinsert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/conversions/batchinsert",
- "request": {
- "$ref": "ConversionsBatchInsertRequest"
- },
- "response": {
- "$ref": "ConversionsBatchInsertResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions"
- ]
- },
- "batchupdate": {
- "description": "Updates existing conversions.",
- "flatPath": "userprofiles/{profileId}/conversions/batchupdate",
- "httpMethod": "POST",
- "id": "dfareporting.conversions.batchupdate",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/conversions/batchupdate",
- "request": {
- "$ref": "ConversionsBatchUpdateRequest"
- },
- "response": {
- "$ref": "ConversionsBatchUpdateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only ads with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "audienceSegmentIds": {
+ "description": "Select only ads with these audience segment IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "campaignIds": {
+ "description": "Select only ads with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "creativeIds": {
+ "description": "Select only ads with these creative IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "creativeOptimizationConfigurationIds": {
+ "description": "Select only ads with these creative optimization configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dynamicClickTracker": {
+ "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only ads with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "landingPageIds": {
+ "description": "Select only ads with these landing page IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only ads with this event tag override ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Select only ads with these placement IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListIds": {
+ "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only ads with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sslCompliant": {
+ "description": "Select only ads that are SSL-compliant.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Select only ads that require SSL.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Select only ads with these types.",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "countries": {
- "methods": {
- "get": {
- "description": "Gets one country by ID.",
- "flatPath": "userprofiles/{profileId}/countries/{dartId}",
- "httpMethod": "GET",
- "id": "dfareporting.countries.get",
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "parameters": {
- "dartId": {
- "description": "Country DART ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/countries/{dartId}",
- "response": {
- "$ref": "Country"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of countries.",
- "flatPath": "userprofiles/{profileId}/countries",
- "httpMethod": "GET",
- "id": "dfareporting.countries.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/countries",
- "response": {
- "$ref": "CountriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "response": {
+ "$ref": "AdsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing ad. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.ads.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeAssets": {
- "methods": {
- "insert": {
- "description": "Inserts a new creative asset.",
- "flatPath": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "httpMethod": "POST",
- "id": "dfareporting.creativeAssets.insert",
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "1073741824",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- }
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Advertiser ID of this creative. This is a required field.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "request": {
- "$ref": "CreativeAssetMetadata"
- },
- "response": {
- "$ref": "CreativeAssetMetadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ],
- "supportsMediaUpload": true
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing ad.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "PUT",
+ "id": "dfareporting.ads.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeFieldValues": {
- "methods": {
- "delete": {
- "description": "Deletes an existing creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.creativeFieldValues.delete",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Creative Field Value ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one creative field value by ID.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFieldValues.get",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Creative Field Value ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "POST",
- "id": "dfareporting.creativeFieldValues.insert",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFieldValues.list",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creative field values with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "VALUE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "response": {
- "$ref": "CreativeFieldValuesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative field value. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeFieldValues.patch",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "CreativeField ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "CreativeFieldValue ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeFieldValues.update",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserGroups": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.advertiserGroups.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeFields": {
- "methods": {
- "delete": {
- "description": "Deletes an existing creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.creativeFields.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative Field ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one creative field by ID.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFields.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative Field ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "POST",
- "id": "dfareporting.creativeFields.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFields.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only creative fields that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creative fields with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "response": {
- "$ref": "CreativeFieldsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative field. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeFields.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "CreativeField ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeFields.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one advertiser group by ID.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeGroups": {
- "methods": {
- "get": {
- "description": "Gets one creative group by ID.",
- "flatPath": "userprofiles/{profileId}/creativeGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups/{id}",
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative group.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "POST",
- "id": "dfareporting.creativeGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "GET",
- "id": "dfareporting.creativeGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only creative groups that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "groupNumber": {
- "description": "Select only creative groups that belong to this subgroup.",
- "format": "int32",
- "location": "query",
- "maximum": "2",
- "minimum": "1",
- "type": "integer"
- },
- "ids": {
- "description": "Select only creative groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "response": {
- "$ref": "CreativeGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "CreativeGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative group.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creatives": {
- "methods": {
- "get": {
- "description": "Gets one creative by ID.",
- "flatPath": "userprofiles/{profileId}/creatives/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creatives.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives/{id}",
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "POST",
- "id": "dfareporting.creatives.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "GET",
- "id": "dfareporting.creatives.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only creatives with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "archived": {
- "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- "location": "query",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Select only creatives with this campaign ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "companionCreativeIds": {
- "description": "Select only in-stream video creatives with these companion IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "creativeFieldIds": {
- "description": "Select only creatives with these creative field IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creatives with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "renderingIds": {
- "description": "Select only creatives with these rendering IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- "location": "query",
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only creatives with these size IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "studioCreativeId": {
- "description": "Select only creatives corresponding to this Studio creative ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "types": {
- "description": "Select only creatives with these creative types.",
- "enum": [
- "IMAGE",
- "DISPLAY_REDIRECT",
- "CUSTOM_DISPLAY",
- "INTERNAL_REDIRECT",
- "CUSTOM_DISPLAY_INTERSTITIAL",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "TRACKING_TEXT",
- "RICH_MEDIA_DISPLAY_BANNER",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_DISPLAY_EXPANDING",
- "RICH_MEDIA_DISPLAY_INTERSTITIAL",
- "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
- "RICH_MEDIA_MOBILE_IN_APP",
- "FLASH_INPAGE",
- "INSTREAM_VIDEO",
- "VPAID_LINEAR_VIDEO",
- "VPAID_NON_LINEAR_VIDEO",
- "INSTREAM_VIDEO_REDIRECT",
- "RICH_MEDIA_PEEL_DOWN",
- "HTML5_BANNER",
- "DISPLAY",
- "DISPLAY_IMAGE_GALLERY",
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "INSTREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "response": {
- "$ref": "CreativesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "PATCH",
- "id": "dfareporting.creatives.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "PUT",
- "id": "dfareporting.creatives.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only advertiser groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "dimensionValues": {
- "methods": {
- "query": {
- "description": "Retrieves list of report dimension values for a list of filters.",
- "flatPath": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "id": "dfareporting.dimensionValues.query",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "100",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "100",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "response": {
+ "$ref": "AdvertiserGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AdvertiserGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "directorySites": {
- "methods": {
- "get": {
- "description": "Gets one directory site by ID.",
- "flatPath": "userprofiles/{profileId}/directorySites/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.directorySites.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Directory site ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites/{id}",
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new directory site.",
- "flatPath": "userprofiles/{profileId}/directorySites",
- "httpMethod": "POST",
- "id": "dfareporting.directorySites.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites",
- "request": {
- "$ref": "DirectorySite"
- },
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/directorySites",
- "httpMethod": "GET",
- "id": "dfareporting.directorySites.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsInterstitialPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsPublisherPaidPlacements": {
- "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- "location": "query",
- "type": "boolean"
- },
- "active": {
- "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- "location": "query",
- "type": "boolean"
- },
- "dfpNetworkCode": {
- "description": "Select only directory sites with this Ad Manager network code.",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only directory sites with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites",
- "response": {
- "$ref": "DirectorySitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "dynamicTargetingKeys": {
- "methods": {
- "delete": {
- "description": "Deletes an existing dynamic targeting key.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
- "httpMethod": "DELETE",
- "id": "dfareporting.dynamicTargetingKeys.delete",
- "parameterOrder": [
- "profileId",
- "objectId",
- "name",
- "objectType"
- ],
- "parameters": {
- "name": {
- "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this dynamic targeting key. This is a required field.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "objectType": {
- "description": "Type of the object of this dynamic targeting key. This is a required field.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
- "httpMethod": "POST",
- "id": "dfareporting.dynamicTargetingKeys.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys",
- "request": {
- "$ref": "DynamicTargetingKey"
- },
- "response": {
- "$ref": "DynamicTargetingKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of dynamic targeting keys.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
- "httpMethod": "GET",
- "id": "dfareporting.dynamicTargetingKeys.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "names": {
- "description": "Select only dynamic targeting keys exactly matching these names.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "objectId": {
- "description": "Select only dynamic targeting keys with this object ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "objectType": {
- "description": "Select only dynamic targeting keys with this object type.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys",
- "response": {
- "$ref": "DynamicTargetingKeysListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserLandingPages": {
+ "methods": {
+ "get": {
+ "description": "Gets one landing page by ID.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Landing page ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "eventTags": {
- "methods": {
- "delete": {
- "description": "Deletes an existing event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.eventTags.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Event tag ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one event tag by ID.",
- "flatPath": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.eventTags.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Event tag ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "POST",
- "id": "dfareporting.eventTags.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of event tags, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "GET",
- "id": "dfareporting.eventTags.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "adId": {
- "description": "Select only event tags that belong to this ad.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "advertiserId": {
- "description": "Select only event tags that belong to this advertiser.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "campaignId": {
- "description": "Select only event tags that belong to this campaign.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "definitionsOnly": {
- "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- "location": "query",
- "type": "boolean"
- },
- "enabled": {
- "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- "location": "query",
- "type": "boolean"
- },
- "eventTagTypes": {
- "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- "enum": [
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG",
- "CLICK_THROUGH_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only event tags with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "response": {
- "$ref": "EventTagsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing event tag. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PATCH",
- "id": "dfareporting.eventTags.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "EventTag ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PUT",
- "id": "dfareporting.eventTags.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new landing page.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserLandingPages.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "files": {
- "methods": {
- "get": {
- "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
- "flatPath": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "id": "dfareporting.files.get",
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "parameters": {
- "fileId": {
- "description": "The ID of the report file.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "reports/{reportId}/files/{fileId}",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "description": "Lists files for a user profile.",
- "flatPath": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "id": "dfareporting.files.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "scope": {
- "default": "MINE",
- "description": "The scope that defines which results are returned.",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/files",
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of landing pages.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only landing pages that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only landing pages that are associated with these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only landing pages with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only landing pages that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "floodlightActivities": {
- "methods": {
- "delete": {
- "description": "Deletes an existing floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.floodlightActivities.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "generatetag": {
- "description": "Generates a tag for a floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivities.generatetag",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID for which we want to generate a tag.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "response": {
- "$ref": "FloodlightActivitiesGenerateTagResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one floodlight activity by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivities.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivities.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivities.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupIds": {
- "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "floodlightActivityGroupName": {
- "description": "Select only floodlight activities with the specified floodlight activity group name.",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupTagString": {
- "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupType": {
- "description": "Select only floodlight activities with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "tagString": {
- "description": "Select only floodlight activities with the specified tag string.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "response": {
- "$ref": "FloodlightActivitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightActivities.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightActivity ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightActivities.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "response": {
+ "$ref": "AdvertiserLandingPagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser landing page. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserLandingPages.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "LandingPage ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "floodlightActivityGroups": {
- "methods": {
- "get": {
- "description": "Gets one floodlight activity group by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivityGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity Group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new floodlight activity group.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivityGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivityGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "type": {
- "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "response": {
- "$ref": "FloodlightActivityGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightActivityGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightActivityGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight activity group.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightActivityGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing landing page.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserLandingPages.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "floodlightConfigurations": {
- "methods": {
- "get": {
- "description": "Gets one floodlight configuration by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightConfigurations.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight configuration ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightConfigurations.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "response": {
- "$ref": "FloodlightConfigurationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightConfigurations.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightConfiguration ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight configuration.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightConfigurations.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertisers": {
+ "methods": {
+ "get": {
+ "description": "Gets one advertiser by ID.",
+ "flatPath": "userprofiles/{profileId}/advertisers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "inventoryItems": {
- "methods": {
- "get": {
- "description": "Gets one inventory item by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.inventoryItems.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Inventory item ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "response": {
- "$ref": "InventoryItem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "httpMethod": "GET",
- "id": "dfareporting.inventoryItems.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only inventory items with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "inPlan": {
- "description": "Select only inventory items that are in plan.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "orderId": {
- "description": "Select only inventory items that belong to specified orders.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "siteId": {
- "description": "Select only inventory items that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "type": {
- "description": "Select only inventory items with this type.",
- "enum": [
- "PLANNING_PLACEMENT_TYPE_REGULAR",
- "PLANNING_PLACEMENT_TYPE_CREDIT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "response": {
- "$ref": "InventoryItemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers/{id}",
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertisers.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "languages": {
- "methods": {
- "list": {
- "description": "Retrieves a list of languages.",
- "flatPath": "userprofiles/{profileId}/languages",
- "httpMethod": "GET",
- "id": "dfareporting.languages.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/languages",
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only advertisers with these advertiser group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "floodlightConfigurationIds": {
+ "description": "Select only advertisers with these floodlight configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only advertisers with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "includeAdvertisersWithoutGroupsOnly": {
+ "description": "Select only advertisers which do not belong to any advertiser group.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "onlyParent": {
+ "description": "Select only advertisers which use another advertiser's floodlight configuration.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Select only advertisers with the specified status.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only advertisers with these subaccount IDs.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "metros": {
- "methods": {
- "list": {
- "description": "Retrieves a list of metros.",
- "flatPath": "userprofiles/{profileId}/metros",
- "httpMethod": "GET",
- "id": "dfareporting.metros.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/metros",
- "response": {
- "$ref": "MetrosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "response": {
+ "$ref": "AdvertisersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertisers.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "mobileApps": {
- "methods": {
- "get": {
- "description": "Gets one mobile app by ID.",
- "flatPath": "userprofiles/{profileId}/mobileApps/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.mobileApps.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Mobile app ID.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileApps/{id}",
- "response": {
- "$ref": "MobileApp"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves list of available mobile apps.",
- "flatPath": "userprofiles/{profileId}/mobileApps",
- "httpMethod": "GET",
- "id": "dfareporting.mobileApps.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "directories": {
- "description": "Select only apps from these directories.",
- "enum": [
- "UNKNOWN",
- "APPLE_APP_STORE",
- "GOOGLE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only apps with these IDs.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileApps",
- "response": {
- "$ref": "MobileAppsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertisers.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "mobileCarriers": {
- "methods": {
- "get": {
- "description": "Gets one mobile carrier by ID.",
- "flatPath": "userprofiles/{profileId}/mobileCarriers/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.mobileCarriers.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Mobile carrier ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileCarriers/{id}",
- "response": {
- "$ref": "MobileCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of mobile carriers.",
- "flatPath": "userprofiles/{profileId}/mobileCarriers",
- "httpMethod": "GET",
- "id": "dfareporting.mobileCarriers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileCarriers",
- "response": {
- "$ref": "MobileCarriersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "browsers": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of browsers.",
+ "flatPath": "userprofiles/{profileId}/browsers",
+ "httpMethod": "GET",
+ "id": "dfareporting.browsers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "operatingSystemVersions": {
- "methods": {
- "get": {
- "description": "Gets one operating system version by ID.",
- "flatPath": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystemVersions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Operating system version ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "response": {
- "$ref": "OperatingSystemVersion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of operating system versions.",
- "flatPath": "userprofiles/{profileId}/operatingSystemVersions",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystemVersions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystemVersions",
- "response": {
- "$ref": "OperatingSystemVersionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/browsers",
+ "response": {
+ "$ref": "BrowsersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaignCreativeAssociations": {
+ "methods": {
+ "insert": {
+ "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaignCreativeAssociations.insert",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "operatingSystems": {
- "methods": {
- "get": {
- "description": "Gets one operating system by DART ID.",
- "flatPath": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystems.get",
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "parameters": {
- "dartId": {
- "description": "Operating system DART ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "response": {
- "$ref": "OperatingSystem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of operating systems.",
- "flatPath": "userprofiles/{profileId}/operatingSystems",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystems.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystems",
- "response": {
- "$ref": "OperatingSystemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "request": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "response": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaignCreativeAssociations.list",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "orderDocuments": {
- "methods": {
- "get": {
- "description": "Gets one order document by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.orderDocuments.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Order document ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "response": {
- "$ref": "OrderDocument"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "httpMethod": "GET",
- "id": "dfareporting.orderDocuments.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "approved": {
- "description": "Select only order documents that have been approved by at least one user.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only order documents with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "orderId": {
- "description": "Select only order documents for specified orders.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
- "location": "query",
- "type": "string"
- },
- "siteId": {
- "description": "Select only order documents that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "response": {
- "$ref": "OrderDocumentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "response": {
+ "$ref": "CampaignCreativeAssociationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaigns": {
+ "methods": {
+ "get": {
+ "description": "Gets one campaign by ID.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "orders": {
- "methods": {
- "get": {
- "description": "Gets one order by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.orders.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Order ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for orders.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders",
- "httpMethod": "GET",
- "id": "dfareporting.orders.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only orders with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for orders.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
- "location": "query",
- "type": "string"
- },
- "siteId": {
- "description": "Select only orders that are associated with these site IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orders",
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{id}",
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new campaign.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaigns.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "placementGroups": {
- "methods": {
- "get": {
- "description": "Gets one placement group by ID.",
- "flatPath": "userprofiles/{profileId}/placementGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placementGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups/{id}",
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement group.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "POST",
- "id": "dfareporting.placementGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "GET",
- "id": "dfareporting.placementGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only placement groups that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only placement groups that belong to these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "contentCategoryIds": {
- "description": "Select only placement groups that are associated with these content categories.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only placement groups that are associated with these directory sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only placement groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxEndDate": {
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "800",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "800",
- "minimum": "0",
- "type": "integer"
- },
- "maxStartDate": {
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minEndDate": {
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minStartDate": {
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "placementGroupType": {
- "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "placementStrategyIds": {
- "description": "Select only placement groups that are associated with these placement strategies.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pricingTypes": {
- "description": "Select only placement groups with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- "location": "query",
- "type": "string"
- },
- "siteIds": {
- "description": "Select only placement groups that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "response": {
- "$ref": "PlacementGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.placementGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "PlacementGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement group.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.placementGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "advertiserIds": {
+ "description": "Select only campaigns that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "atLeastOneOptimizationActivity": {
+ "description": "Select only campaigns that have at least one optimization activity.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "excludedIds": {
+ "description": "Exclude campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only campaigns that have overridden this event tag ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only campaigns that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "placementStrategies": {
- "methods": {
- "delete": {
- "description": "Deletes an existing placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.placementStrategies.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement strategy ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one placement strategy by ID.",
- "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placementStrategies.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement strategy ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "POST",
- "id": "dfareporting.placementStrategies.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "GET",
- "id": "dfareporting.placementStrategies.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only placement strategies with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "response": {
- "$ref": "PlacementStrategiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement strategy. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PATCH",
- "id": "dfareporting.placementStrategies.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "PlacementStrategy ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PUT",
- "id": "dfareporting.placementStrategies.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "response": {
+ "$ref": "CampaignsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing campaign. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.campaigns.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "placements": {
- "methods": {
- "generatetags": {
- "description": "Generates tags for a placement.",
- "flatPath": "userprofiles/{profileId}/placements/generatetags",
- "httpMethod": "POST",
- "id": "dfareporting.placements.generatetags",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Generate placements belonging to this campaign. This is a required field.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "placementIds": {
- "description": "Generate tags for these placements.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "tagFormats": {
- "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements/generatetags",
- "response": {
- "$ref": "PlacementsGenerateTagsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one placement by ID.",
- "flatPath": "userprofiles/{profileId}/placements/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placements.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements/{id}",
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "POST",
- "id": "dfareporting.placements.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "GET",
- "id": "dfareporting.placements.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only placements that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only placements that belong to these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "compatibilities": {
- "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "contentCategoryIds": {
- "description": "Select only placements that are associated with these content categories.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only placements that are associated with these directory sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "groupIds": {
- "description": "Select only placements that belong to these placement groups.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only placements with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxEndDate": {
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "maxStartDate": {
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minEndDate": {
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minStartDate": {
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "paymentSource": {
- "description": "Select only placements with this payment source.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "placementStrategyIds": {
- "description": "Select only placements that are associated with these placement strategies.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pricingTypes": {
- "description": "Select only placements with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .",
- "location": "query",
- "type": "string"
- },
- "siteIds": {
- "description": "Select only placements that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only placements that are associated with these sizes.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "response": {
- "$ref": "PlacementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "PATCH",
- "id": "dfareporting.placements.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "PUT",
- "id": "dfareporting.placements.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing campaign.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "PUT",
+ "id": "dfareporting.campaigns.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "platformTypes": {
- "methods": {
- "get": {
- "description": "Gets one platform type by ID.",
- "flatPath": "userprofiles/{profileId}/platformTypes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.platformTypes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Platform type ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/platformTypes/{id}",
- "response": {
- "$ref": "PlatformType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of platform types.",
- "flatPath": "userprofiles/{profileId}/platformTypes",
- "httpMethod": "GET",
- "id": "dfareporting.platformTypes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/platformTypes",
- "response": {
- "$ref": "PlatformTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "changeLogs": {
+ "methods": {
+ "get": {
+ "description": "Gets one change log by ID.",
+ "flatPath": "userprofiles/{profileId}/changeLogs/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Change log ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "postalCodes": {
- "methods": {
- "get": {
- "description": "Gets one postal code by ID.",
- "flatPath": "userprofiles/{profileId}/postalCodes/{code}",
- "httpMethod": "GET",
- "id": "dfareporting.postalCodes.get",
- "parameterOrder": [
- "profileId",
- "code"
- ],
- "parameters": {
- "code": {
- "description": "Postal code ID.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/postalCodes/{code}",
- "response": {
- "$ref": "PostalCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of postal codes.",
- "flatPath": "userprofiles/{profileId}/postalCodes",
- "httpMethod": "GET",
- "id": "dfareporting.postalCodes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/postalCodes",
- "response": {
- "$ref": "PostalCodesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/changeLogs/{id}",
+ "response": {
+ "$ref": "ChangeLog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of change logs. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/changeLogs",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "action": {
+ "description": "Select only change logs with the specified action.",
+ "enum": [
+ "ACTION_CREATE",
+ "ACTION_UPDATE",
+ "ACTION_DELETE",
+ "ACTION_ENABLE",
+ "ACTION_DISABLE",
+ "ACTION_ADD",
+ "ACTION_REMOVE",
+ "ACTION_MARK_AS_DEFAULT",
+ "ACTION_ASSOCIATE",
+ "ACTION_ASSIGN",
+ "ACTION_UNASSIGN",
+ "ACTION_SEND",
+ "ACTION_LINK",
+ "ACTION_UNLINK",
+ "ACTION_PUSH",
+ "ACTION_EMAIL_TAGS",
+ "ACTION_SHARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only change logs with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxChangeTime": {
+ "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "minChangeTime": {
+ "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Select only change logs with these object IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Select only change logs with the specified object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_FLOODLIGHT_CONFIGURATION",
+ "OBJECT_AD",
+ "OBJECT_FLOODLIGHT_ACTVITY",
+ "OBJECT_CAMPAIGN",
+ "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT",
+ "OBJECT_DFA_SITE",
+ "OBJECT_USER_ROLE",
+ "OBJECT_USER_PROFILE",
+ "OBJECT_ADVERTISER_GROUP",
+ "OBJECT_ACCOUNT",
+ "OBJECT_SUBACCOUNT",
+ "OBJECT_RICHMEDIA_CREATIVE",
+ "OBJECT_INSTREAM_CREATIVE",
+ "OBJECT_MEDIA_ORDER",
+ "OBJECT_CONTENT_CATEGORY",
+ "OBJECT_PLACEMENT_STRATEGY",
+ "OBJECT_SD_SITE",
+ "OBJECT_SIZE",
+ "OBJECT_CREATIVE_GROUP",
+ "OBJECT_CREATIVE_ASSET",
+ "OBJECT_USER_PROFILE_FILTER",
+ "OBJECT_LANDING_PAGE",
+ "OBJECT_CREATIVE_FIELD",
+ "OBJECT_REMARKETING_LIST",
+ "OBJECT_PROVIDED_LIST_CLIENT",
+ "OBJECT_EVENT_TAG",
+ "OBJECT_CREATIVE_BUNDLE",
+ "OBJECT_BILLING_ACCOUNT_GROUP",
+ "OBJECT_BILLING_FEATURE",
+ "OBJECT_RATE_CARD",
+ "OBJECT_ACCOUNT_BILLING_FEATURE",
+ "OBJECT_BILLING_MINIMUM_FEE",
+ "OBJECT_BILLING_PROFILE",
+ "OBJECT_PLAYSTORE_LINK",
+ "OBJECT_TARGETING_TEMPLATE",
+ "OBJECT_SEARCH_LIFT_STUDY",
+ "OBJECT_FLOODLIGHT_DV360_LINK"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
+ "location": "query",
+ "type": "string"
+ },
+ "userProfileIds": {
+ "description": "Select only change logs with these user profile IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "projects": {
- "methods": {
- "get": {
- "description": "Gets one project by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.projects.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Project ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{id}",
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
- "flatPath": "userprofiles/{profileId}/projects",
- "httpMethod": "GET",
- "id": "dfareporting.projects.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only projects with these advertiser IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only projects with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects",
- "response": {
- "$ref": "ProjectsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/changeLogs",
+ "response": {
+ "$ref": "ChangeLogsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "cities": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of cities, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/cities",
+ "httpMethod": "GET",
+ "id": "dfareporting.cities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "countryDartIds": {
+ "description": "Select only cities from these countries.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dartIds": {
+ "description": "Select only cities with these DART IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "namePrefix": {
+ "description": "Select only cities with names starting with this prefix.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionDartIds": {
+ "description": "Select only cities from these regions.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "regions": {
- "methods": {
- "list": {
- "description": "Retrieves a list of regions.",
- "flatPath": "userprofiles/{profileId}/regions",
- "httpMethod": "GET",
- "id": "dfareporting.regions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/regions",
- "response": {
- "$ref": "RegionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/cities",
+ "response": {
+ "$ref": "CitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "connectionTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one connection type by ID.",
+ "flatPath": "userprofiles/{profileId}/connectionTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Connection type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "remarketingListShares": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list share by remarketing list ID.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingListShares.get",
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "remarketingListId": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing remarketing list share. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PATCH",
- "id": "dfareporting.remarketingListShares.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "RemarketingList ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares",
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing remarketing list share.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PUT",
- "id": "dfareporting.remarketingListShares.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares",
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/connectionTypes/{id}",
+ "response": {
+ "$ref": "ConnectionType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of connection types.",
+ "flatPath": "userprofiles/{profileId}/connectionTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "remarketingLists": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list by ID.",
- "flatPath": "userprofiles/{profileId}/remarketingLists/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingLists.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists/{id}",
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new remarketing list.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "POST",
- "id": "dfareporting.remarketingLists.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingLists.list",
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active or only inactive remarketing lists.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only remarketing lists owned by this advertiser.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "floodlightActivityId": {
- "description": "Select only remarketing lists that have this floodlight activity ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "name": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "response": {
- "$ref": "RemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing remarketing list. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PATCH",
- "id": "dfareporting.remarketingLists.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "RemarketingList ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing remarketing list.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PUT",
- "id": "dfareporting.remarketingLists.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/connectionTypes",
+ "response": {
+ "$ref": "ConnectionTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "contentCategories": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.contentCategories.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "reports": {
- "methods": {
- "delete": {
- "description": "Deletes a report by its ID.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "id": "dfareporting.reports.delete",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "description": "Retrieves a report by its ID.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "id": "dfareporting.reports.get",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "description": "Creates a report.",
- "flatPath": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "id": "dfareporting.reports.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "description": "Retrieves list of reports.",
- "flatPath": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "id": "dfareporting.reports.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "scope": {
- "default": "MINE",
- "description": "The scope that defines which results are returned.",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports",
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "description": "Updates an existing report. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "id": "dfareporting.reports.patch",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The DFA user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "description": "Runs a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "id": "dfareporting.reports.run",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "synchronous": {
- "default": "false",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "description": "Updates a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "id": "dfareporting.reports.update",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one content category by ID.",
+ "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "flatPath": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "id": "dfareporting.reports.compatibleFields.query",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "id": "dfareporting.reports.files.get",
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "parameters": {
- "fileId": {
- "description": "The ID of the report file.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "description": "Lists files for a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "id": "dfareporting.reports.files.list",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the parent report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "sites": {
- "methods": {
- "get": {
- "description": "Gets one site by ID.",
- "flatPath": "userprofiles/{profileId}/sites/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.sites.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Site ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites/{id}",
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new site.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "POST",
- "id": "dfareporting.sites.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "GET",
- "id": "dfareporting.sites.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsInterstitialPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsPublisherPaidPlacements": {
- "description": "Select only sites that accept publisher paid placements.",
- "location": "query",
- "type": "boolean"
- },
- "adWordsSite": {
- "description": "Select only AdWords sites.",
- "location": "query",
- "type": "boolean"
- },
- "approved": {
- "description": "Select only approved sites.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only sites with these campaign IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only sites with these directory site IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only sites with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only sites with this subaccount ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "unmappedSite": {
- "description": "Select only sites that have not been mapped to a directory site.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "response": {
- "$ref": "SitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing site. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "PATCH",
- "id": "dfareporting.sites.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Site ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing site.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "PUT",
- "id": "dfareporting.sites.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories/{id}",
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "POST",
+ "id": "dfareporting.contentCategories.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "sizes": {
- "methods": {
- "get": {
- "description": "Gets one size by ID.",
- "flatPath": "userprofiles/{profileId}/sizes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.sizes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Size ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sizes/{id}",
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new size.",
- "flatPath": "userprofiles/{profileId}/sizes",
- "httpMethod": "POST",
- "id": "dfareporting.sizes.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sizes",
- "request": {
- "$ref": "Size"
- },
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
- "flatPath": "userprofiles/{profileId}/sizes",
- "httpMethod": "GET",
- "id": "dfareporting.sizes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "height": {
- "description": "Select only sizes with this height.",
- "format": "int32",
- "location": "query",
- "maximum": "32767",
- "minimum": "0",
- "type": "integer"
- },
- "iabStandard": {
- "description": "Select only IAB standard sizes.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only sizes with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "width": {
- "description": "Select only sizes with this width.",
- "format": "int32",
- "location": "query",
- "maximum": "32767",
- "minimum": "0",
- "type": "integer"
- }
- },
- "path": "userprofiles/{profileId}/sizes",
- "response": {
- "$ref": "SizesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only content categories with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "subaccounts": {
- "methods": {
- "get": {
- "description": "Gets one subaccount by ID.",
- "flatPath": "userprofiles/{profileId}/subaccounts/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.subaccounts.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Subaccount ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts/{id}",
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new subaccount.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "POST",
- "id": "dfareporting.subaccounts.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "GET",
- "id": "dfareporting.subaccounts.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only subaccounts with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "response": {
- "$ref": "SubaccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing subaccount. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PATCH",
- "id": "dfareporting.subaccounts.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Subaccount ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing subaccount.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PUT",
- "id": "dfareporting.subaccounts.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "response": {
+ "$ref": "ContentCategoriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing content category. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.contentCategories.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ContentCategory ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "targetableRemarketingLists": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list by ID.",
- "flatPath": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.targetableRemarketingLists.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "response": {
- "$ref": "TargetableRemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/targetableRemarketingLists",
- "httpMethod": "GET",
- "id": "dfareporting.targetableRemarketingLists.list",
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active or only inactive targetable remarketing lists.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only targetable remarketing lists targetable by these advertisers.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "name": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetableRemarketingLists",
- "response": {
- "$ref": "TargetableRemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PUT",
+ "id": "dfareporting.contentCategories.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "targetingTemplates": {
- "methods": {
- "get": {
- "description": "Gets one targeting template by ID.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.targetingTemplates.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Targeting template ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates/{id}",
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new targeting template.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "POST",
- "id": "dfareporting.targetingTemplates.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "GET",
- "id": "dfareporting.targetingTemplates.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only targeting templates with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only targeting templates with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "response": {
- "$ref": "TargetingTemplatesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing targeting template. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "PATCH",
- "id": "dfareporting.targetingTemplates.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "TargetingTemplate ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing targeting template.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "PUT",
- "id": "dfareporting.targetingTemplates.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "conversions": {
+ "methods": {
+ "batchinsert": {
+ "description": "Inserts conversions.",
+ "flatPath": "userprofiles/{profileId}/conversions/batchinsert",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchinsert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userProfiles": {
- "methods": {
- "get": {
- "description": "Gets one user profile by ID.",
- "flatPath": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "id": "dfareporting.userProfiles.get",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}",
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions",
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves list of user profiles for a user.",
- "flatPath": "userprofiles",
- "httpMethod": "GET",
- "id": "dfareporting.userProfiles.list",
- "parameterOrder": [],
- "parameters": {},
- "path": "userprofiles",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions",
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/conversions/batchinsert",
+ "request": {
+ "$ref": "ConversionsBatchInsertRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchInsertResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ },
+ "batchupdate": {
+ "description": "Updates existing conversions.",
+ "flatPath": "userprofiles/{profileId}/conversions/batchupdate",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchupdate",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRolePermissionGroups": {
- "methods": {
- "get": {
- "description": "Gets one user role permission group by ID.",
- "flatPath": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissionGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role permission group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "response": {
- "$ref": "UserRolePermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of all supported user role permission groups.",
- "flatPath": "userprofiles/{profileId}/userRolePermissionGroups",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissionGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissionGroups",
- "response": {
- "$ref": "UserRolePermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/conversions/batchupdate",
+ "request": {
+ "$ref": "ConversionsBatchUpdateRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchUpdateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ }
+ }
+ },
+ "countries": {
+ "methods": {
+ "get": {
+ "description": "Gets one country by ID.",
+ "flatPath": "userprofiles/{profileId}/countries/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Country DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRolePermissions": {
- "methods": {
- "get": {
- "description": "Gets one user role permission by ID.",
- "flatPath": "userprofiles/{profileId}/userRolePermissions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role permission ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- "response": {
- "$ref": "UserRolePermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of user role permissions, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/userRolePermissions",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only user role permissions with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissions",
- "response": {
- "$ref": "UserRolePermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/countries/{dartId}",
+ "response": {
+ "$ref": "Country"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of countries.",
+ "flatPath": "userprofiles/{profileId}/countries",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRoles": {
- "methods": {
- "delete": {
- "description": "Deletes an existing user role.",
- "flatPath": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.userRoles.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one user role by ID.",
- "flatPath": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRoles.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new user role.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "POST",
- "id": "dfareporting.userRoles.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "GET",
- "id": "dfareporting.userRoles.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "accountUserRoleOnly": {
- "description": "Select only account level user roles not associated with any specific subaccount.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only user roles with the specified IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only user roles that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "response": {
- "$ref": "UserRolesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing user role. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PATCH",
- "id": "dfareporting.userRoles.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "UserRole ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing user role.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PUT",
- "id": "dfareporting.userRoles.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/countries",
+ "response": {
+ "$ref": "CountriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeAssets": {
+ "methods": {
+ "insert": {
+ "description": "Inserts a new creative asset.",
+ "flatPath": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeAssets.insert",
+ "mediaUpload": {
+ "accept": [
+ "*/*"
+ ],
+ "maxSize": "1073741824",
+ "protocols": {
+ "simple": {
+ "multipart": true,
+ "path": "/upload/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
+ }
}
- },
- "videoFormats": {
- "methods": {
- "get": {
- "description": "Gets one video format by ID.",
- "flatPath": "userprofiles/{profileId}/videoFormats/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.videoFormats.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Video format ID.",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/videoFormats/{id}",
- "response": {
- "$ref": "VideoFormat"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Lists available video formats.",
- "flatPath": "userprofiles/{profileId}/videoFormats",
- "httpMethod": "GET",
- "id": "dfareporting.videoFormats.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/videoFormats",
- "response": {
- "$ref": "VideoFormatsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "request": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "response": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ],
+ "supportsMediaUpload": true
}
+ }
},
- "revision": "20210210",
- "rootUrl": "https://dfareporting.googleapis.com/",
- "schemas": {
- "Account": {
- "description": "Contains properties of a Campaign Manager account.",
- "id": "Account",
- "properties": {
- "accountPermissionIds": {
- "description": "Account permissions assigned to this account.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "accountProfile": {
- "description": "Profile for this account. This is a read-only field that can be left blank.",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "active": {
- "description": "Whether this account is active.",
- "type": "boolean"
- },
- "activeAdsLimitTier": {
- "description": "Maximum number of active ads allowed for this account.",
- "enum": [
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K",
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_500K",
- "ACTIVE_ADS_TIER_750K",
- "ACTIVE_ADS_TIER_1M"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "activeViewOptOut": {
- "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.",
- "type": "boolean"
- },
- "availablePermissionIds": {
- "description": "User role permissions available to the user roles of this account.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "countryId": {
- "description": "ID of the country associated with this account.",
- "format": "int64",
- "type": "string"
- },
- "currencyId": {
- "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ",
- "format": "int64",
- "type": "string"
- },
- "defaultCreativeSizeId": {
- "description": "Default placement dimensions for this account.",
- "format": "int64",
- "type": "string"
- },
- "description": {
- "description": "Description of this account.",
- "type": "string"
- },
- "id": {
- "description": "ID of this account. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
- "type": "string"
- },
- "locale": {
- "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
- "type": "string"
- },
- "maximumImageSize": {
- "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.",
- "type": "string"
- },
- "nielsenOcrEnabled": {
- "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.",
- "type": "boolean"
- },
- "reportsConfiguration": {
- "$ref": "ReportsConfiguration",
- "description": "Reporting configuration of this account."
- },
- "shareReportsWithTwitter": {
- "description": "Share Path to Conversion reports with Twitter.",
- "type": "boolean"
- },
- "teaserSizeLimit": {
- "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
- "format": "int64",
- "type": "string"
- }
+ "creativeFieldValues": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFieldValues.delete",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountActiveAdSummary": {
- "description": "Gets a summary of active ads in an account.",
- "id": "AccountActiveAdSummary",
- "properties": {
- "accountId": {
- "description": "ID of the account.",
- "format": "int64",
- "type": "string"
- },
- "activeAds": {
- "description": "Ads that have been activated for the account",
- "format": "int64",
- "type": "string"
- },
- "activeAdsLimitTier": {
- "description": "Maximum number of active ads allowed for the account.",
- "enum": [
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K",
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_500K",
- "ACTIVE_ADS_TIER_750K",
- "ACTIVE_ADS_TIER_1M"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "availableAds": {
- "description": "Ads that can be activated for the account.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
- "type": "string"
- }
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermission": {
- "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
- "id": "AccountPermission",
- "properties": {
- "accountProfiles": {
- "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
- "items": {
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this account permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
- "type": "string"
- },
- "level": {
- "description": "Administrative level required to enable this account permission.",
- "enum": [
- "USER",
- "ADMINISTRATOR"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of this account permission.",
- "type": "string"
- },
- "permissionGroupId": {
- "description": "Permission group of this account permission.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field value by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.get",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionGroup": {
- "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
- "id": "AccountPermissionGroup",
- "properties": {
- "id": {
- "description": "ID of this account permission group.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this account permission group.",
- "type": "string"
- }
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionGroupsListResponse": {
- "description": "Account Permission Group List Response",
- "id": "AccountPermissionGroupsListResponse",
- "properties": {
- "accountPermissionGroups": {
- "description": "Account permission group collection.",
- "items": {
- "$ref": "AccountPermissionGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFieldValues.insert",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionsListResponse": {
- "description": "Account Permission List Response",
- "id": "AccountPermissionsListResponse",
- "properties": {
- "accountPermissions": {
- "description": "Account permission collection.",
- "items": {
- "$ref": "AccountPermission"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.list",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountUserProfile": {
- "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
- "id": "AccountUserProfile",
- "properties": {
- "accountId": {
- "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.",
- "type": "boolean"
- },
- "advertiserFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which advertisers are visible to the user profile."
- },
- "campaignFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which campaigns are visible to the user profile."
- },
- "comments": {
- "description": "Comments for this user profile.",
- "type": "string"
- },
- "email": {
- "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.",
- "type": "string"
- },
- "id": {
- "description": "ID of the user profile. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
- "type": "string"
- },
- "locale": {
- "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
- "type": "string"
- },
- "name": {
- "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".",
- "type": "string"
- },
- "siteFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which sites are visible to the user profile."
- },
- "subaccountId": {
- "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "traffickerType": {
- "description": "Trafficker type of this user profile. This is a read-only field.",
- "enum": [
- "INTERNAL_NON_TRAFFICKER",
- "INTERNAL_TRAFFICKER",
- "EXTERNAL_TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "userAccessType": {
- "description": "User type of the user profile. This is a read-only field that can be left blank.",
- "enum": [
- "NORMAL_USER",
- "SUPER_USER",
- "INTERNAL_ADMINISTRATOR",
- "READ_ONLY_SUPER_USER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "userRoleFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which user roles are visible to the user profile."
- },
- "userRoleId": {
- "description": "User role ID of the user profile. This is a required field.",
- "format": "int64",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative field values with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountUserProfilesListResponse": {
- "description": "Account User Profile List Response",
- "id": "AccountUserProfilesListResponse",
- "properties": {
- "accountUserProfiles": {
- "description": "Account user profile collection.",
- "items": {
- "$ref": "AccountUserProfile"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "AccountsListResponse": {
- "description": "Account List Response",
- "id": "AccountsListResponse",
- "properties": {
- "accounts": {
- "description": "Account collection.",
- "items": {
- "$ref": "Account"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Activities": {
- "description": "Represents an activity group.",
- "id": "Activities",
- "properties": {
- "filters": {
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "type": "string"
- },
- "metricNames": {
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Ad": {
- "description": "Contains properties of a Campaign Manager ad.",
- "id": "Ad",
- "properties": {
- "accountId": {
- "description": "Account ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this ad is active. When true, archived must be false.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Advertiser ID of this ad. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this ad is archived. When true, active must be false.",
- "type": "boolean"
- },
- "audienceSegmentId": {
- "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64",
- "type": "string"
- },
- "campaignId": {
- "description": "Campaign ID of this ad. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
- },
- "comments": {
- "description": "Comments for this ad.",
- "type": "string"
- },
- "compatibility": {
- "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this ad. This is a read-only field."
- },
- "creativeGroupAssignments": {
- "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- },
- "type": "array"
- },
- "creativeRotation": {
- "$ref": "CreativeRotation",
- "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Default click-through event tag properties for this ad."
- },
- "deliverySchedule": {
- "$ref": "DeliverySchedule",
- "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
- },
- "dynamicClickTracker": {
- "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.",
- "type": "boolean"
- },
- "endTime": {
- "format": "date-time",
- "type": "string"
- },
- "eventTagOverrides": {
- "description": "Event tag overrides for this ad.",
- "items": {
- "$ref": "EventTagOverride"
- },
- "type": "array"
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "id": {
- "description": "ID of this ad. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
- "type": "string"
- },
- "languageTargeting": {
- "$ref": "LanguageTargeting",
- "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this ad. This is a read-only field."
- },
- "name": {
- "description": "Name of this ad. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "placementAssignments": {
- "description": "Placement assignments for this ad.",
- "items": {
- "$ref": "PlacementAssignment"
- },
- "type": "array"
- },
- "remarketingListExpression": {
- "$ref": "ListTargetingExpression",
- "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "size": {
- "$ref": "Size",
- "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
- },
- "sslCompliant": {
- "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "startTime": {
- "format": "date-time",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "targetingTemplateId": {
- "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64",
- "type": "string"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "type": {
- "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
- "enum": [
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_TRACKING",
- "AD_SERVING_BRAND_SAFE_AD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "AdBlockingConfiguration": {
- "description": "Campaign ad blocking settings.",
- "id": "AdBlockingConfiguration",
- "properties": {
- "clickThroughUrl": {
- "description": "Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.",
- "type": "string"
- },
- "creativeBundleId": {
- "description": "ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.",
- "format": "int64",
- "type": "string"
- },
- "enabled": {
- "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.",
- "type": "boolean"
- },
- "overrideClickThroughUrl": {
- "description": "Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.",
- "type": "boolean"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "VALUE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "AdSlot": {
- "description": "Ad Slot",
- "id": "AdSlot",
- "properties": {
- "comment": {
- "description": "Comment for this ad slot.",
- "type": "string"
- },
- "compatibility": {
- "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "height": {
- "description": "Height of this ad slot.",
- "format": "int64",
- "type": "string"
- },
- "linkedPlacementId": {
- "description": "ID of the placement from an external platform that is linked to this ad slot.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this ad slot.",
- "type": "string"
- },
- "paymentSourceType": {
- "description": "Payment source type of this ad slot.",
- "enum": [
- "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
- "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "primary": {
- "description": "Primary ad slot of a roadblock inventory item.",
- "type": "boolean"
- },
- "width": {
- "description": "Width of this ad slot.",
- "format": "int64",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "response": {
+ "$ref": "CreativeFieldValuesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field value. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFieldValues.patch",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdsListResponse": {
- "description": "Ad List Response",
- "id": "AdsListResponse",
- "properties": {
- "ads": {
- "description": "Ad collection.",
- "items": {
- "$ref": "Ad"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "id": {
+ "description": "CreativeFieldValue ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Advertiser": {
- "description": "Contains properties of a Campaign Manager advertiser.",
- "id": "Advertiser",
- "properties": {
- "accountId": {
- "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserGroupId": {
- "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
- "format": "int64",
- "type": "string"
- },
- "clickThroughUrlSuffix": {
- "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
- "type": "string"
- },
- "defaultClickThroughEventTagId": {
- "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
- "format": "int64",
- "type": "string"
- },
- "defaultEmail": {
- "description": "Default email address used in sender field for tag emails.",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this advertiser. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
- "type": "string"
- },
- "originalFloodlightConfigurationId": {
- "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "description": "Status of this advertiser.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "suspended": {
- "description": "Suspension status of this advertiser.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFieldValues.update",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserGroup": {
- "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
- "id": "AdvertiserGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeFields": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFields.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserGroupsListResponse": {
- "description": "Advertiser Group List Response",
- "id": "AdvertiserGroupsListResponse",
- "properties": {
- "advertiserGroups": {
- "description": "Advertiser group collection.",
- "items": {
- "$ref": "AdvertiserGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserLandingPagesListResponse": {
- "description": "Landing Page List Response",
- "id": "AdvertiserLandingPagesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
- "type": "string"
- },
- "landingPages": {
- "description": "Landing page collection",
- "items": {
- "$ref": "LandingPage"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{id}",
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFields.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative fields that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertisersListResponse": {
- "description": "Advertiser List Response",
- "id": "AdvertisersListResponse",
- "properties": {
- "advertisers": {
- "description": "Advertiser collection.",
- "items": {
- "$ref": "Advertiser"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative fields with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AudienceSegment": {
- "description": "Audience Segment.",
- "id": "AudienceSegment",
- "properties": {
- "allocation": {
- "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "ID of this audience segment. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "AudienceSegmentGroup": {
- "description": "Audience Segment Group.",
- "id": "AudienceSegmentGroup",
- "properties": {
- "audienceSegments": {
- "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
- "items": {
- "$ref": "AudienceSegment"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Browser": {
- "description": "Contains information about a browser that can be targeted by ads.",
- "id": "Browser",
- "properties": {
- "browserVersionId": {
- "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this browser. This is the ID used when generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
- "type": "string"
- },
- "majorVersion": {
- "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
- "type": "string"
- },
- "minorVersion": {
- "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
- "type": "string"
- },
- "name": {
- "description": "Name of this browser.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "BrowsersListResponse": {
- "description": "Browser List Response",
- "id": "BrowsersListResponse",
- "properties": {
- "browsers": {
- "description": "Browser collection.",
- "items": {
- "$ref": "Browser"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Campaign": {
- "description": "Contains properties of a Campaign Manager campaign.",
- "id": "Campaign",
- "properties": {
- "accountId": {
- "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "adBlockingConfiguration": {
- "$ref": "AdBlockingConfiguration",
- "description": "Ad blocking settings for this campaign."
- },
- "additionalCreativeOptimizationConfigurations": {
- "description": "Additional creative optimization configurations for the campaign.",
- "items": {
- "$ref": "CreativeOptimizationConfiguration"
- },
- "type": "array"
- },
- "advertiserGroupId": {
- "description": "Advertiser group ID of the associated advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this campaign. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this campaign has been archived.",
- "type": "boolean"
- },
- "audienceSegmentGroups": {
- "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
- "items": {
- "$ref": "AudienceSegmentGroup"
- },
- "type": "array"
- },
- "billingInvoiceCode": {
- "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.",
- "type": "string"
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix override properties for this campaign."
- },
- "comment": {
- "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this campaign. This is a read-only field."
- },
- "creativeGroupIds": {
- "description": "List of creative group IDs that are assigned to the campaign.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "creativeOptimizationConfiguration": {
- "$ref": "CreativeOptimizationConfiguration",
- "description": "Creative optimization configuration for the campaign."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Click-through event tag ID override properties for this campaign."
- },
- "defaultLandingPageId": {
- "description": "The default landing page ID for this campaign.",
- "format": "int64",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "eventTagOverrides": {
- "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
- "items": {
- "$ref": "EventTagOverride"
- },
- "type": "array"
- },
- "externalId": {
- "description": "External ID for this campaign.",
- "type": "string"
- },
- "id": {
- "description": "ID of this campaign. This is a read-only auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this campaign. This is a read-only field."
- },
- "name": {
- "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.",
- "type": "string"
- },
- "nielsenOcrEnabled": {
- "description": "Whether Nielsen reports are enabled for this campaign.",
- "type": "boolean"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "traffickerEmails": {
- "description": "Campaign trafficker contact emails.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CampaignCreativeAssociation": {
- "description": "Identifies a creative which has been associated with a given campaign.",
- "id": "CampaignCreativeAssociation",
- "properties": {
- "creativeId": {
- "description": "ID of the creative associated with the campaign. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "response": {
+ "$ref": "CreativeFieldsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFields.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CampaignCreativeAssociationsListResponse": {
- "description": "Campaign Creative Association List Response",
- "id": "CampaignCreativeAssociationsListResponse",
- "properties": {
- "campaignCreativeAssociations": {
- "description": "Campaign creative association collection",
- "items": {
- "$ref": "CampaignCreativeAssociation"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFields.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative group by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CampaignsListResponse": {
- "description": "Campaign List Response",
- "id": "CampaignsListResponse",
- "properties": {
- "campaigns": {
- "description": "Campaign collection.",
- "items": {
- "$ref": "Campaign"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups/{id}",
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative group.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ChangeLog": {
- "description": "Describes a change that a user has made to a resource.",
- "id": "ChangeLog",
- "properties": {
- "accountId": {
- "description": "Account ID of the modified object.",
- "format": "int64",
- "type": "string"
- },
- "action": {
- "description": "Action which caused the change.",
- "type": "string"
- },
- "changeTime": {
- "format": "date-time",
- "type": "string"
- },
- "fieldName": {
- "description": "Field name of the object which changed.",
- "type": "string"
- },
- "id": {
- "description": "ID of this change log.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
- "type": "string"
- },
- "newValue": {
- "description": "New value of the object field.",
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
- "format": "int64",
- "type": "string"
- },
- "objectType": {
- "description": "Object type of the change log.",
- "type": "string"
- },
- "oldValue": {
- "description": "Old value of the object field.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of the modified object.",
- "format": "int64",
- "type": "string"
- },
- "transactionId": {
- "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
- "format": "int64",
- "type": "string"
- },
- "userProfileId": {
- "description": "ID of the user who modified the object.",
- "format": "int64",
- "type": "string"
- },
- "userProfileName": {
- "description": "User profile name of the user who modified the object.",
- "type": "string"
- }
+ "groupNumber": {
+ "description": "Select only creative groups that belong to this subgroup.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "2",
+ "minimum": "1",
+ "type": "integer"
},
- "type": "object"
- },
- "ChangeLogsListResponse": {
- "description": "Change Log List Response",
- "id": "ChangeLogsListResponse",
- "properties": {
- "changeLogs": {
- "description": "Change log collection.",
- "items": {
- "$ref": "ChangeLog"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CitiesListResponse": {
- "description": "City List Response",
- "id": "CitiesListResponse",
- "properties": {
- "cities": {
- "description": "City collection.",
- "items": {
- "$ref": "City"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "City": {
- "description": "Contains information about a city that can be targeted by ads.",
- "id": "City",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this city belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this city belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
- "type": "string"
- },
- "metroCode": {
- "description": "Metro region code of the metro region (DMA) to which this city belongs.",
- "type": "string"
- },
- "metroDmaId": {
- "description": "ID of the metro region (DMA) to which this city belongs.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this city.",
- "type": "string"
- },
- "regionCode": {
- "description": "Region code of the region to which this city belongs.",
- "type": "string"
- },
- "regionDartId": {
- "description": "DART ID of the region to which this city belongs.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ClickTag": {
- "description": "Creative Click Tag.",
- "id": "ClickTag",
- "properties": {
- "clickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Parameter value for the specified click tag. This field contains a click-through url."
- },
- "eventName": {
- "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "string"
- },
- "name": {
- "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ClickThroughUrl": {
- "description": "Click-through URL",
- "id": "ClickThroughUrl",
- "properties": {
- "computedClickThroughUrl": {
- "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
- "type": "string"
- },
- "customClickThroughUrl": {
- "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
- "type": "string"
- },
- "defaultLandingPage": {
- "description": "Whether the campaign default landing page is used.",
- "type": "boolean"
- },
- "landingPageId": {
- "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ClickThroughUrlSuffixProperties": {
- "description": "Click Through URL Suffix settings.",
- "id": "ClickThroughUrlSuffixProperties",
- "properties": {
- "clickThroughUrlSuffix": {
- "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
- "type": "string"
- },
- "overrideInheritedSuffix": {
- "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
- "type": "boolean"
- }
+ "searchString": {
+ "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CompanionClickThroughOverride": {
- "description": "Companion Click-through override.",
- "id": "CompanionClickThroughOverride",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this companion click-through override."
- },
- "creativeId": {
- "description": "ID of the creative for this companion click-through override.",
- "format": "int64",
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CompanionSetting": {
- "description": "Companion Settings",
- "id": "CompanionSetting",
- "properties": {
- "companionsDisabled": {
- "description": "Whether companions are disabled for this placement.",
- "type": "boolean"
- },
- "enabledSizes": {
- "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "imageOnly": {
- "description": "Whether to serve only static images as companions.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "response": {
+ "$ref": "CreativeGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CompatibleFields": {
- "description": "Represents a response to the queryCompatibleFields method.",
- "id": "CompatibleFields",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "type": "string"
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative group.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative by ID.",
+ "flatPath": "userprofiles/{profileId}/creatives/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConnectionType": {
- "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
- "id": "ConnectionType",
- "properties": {
- "id": {
- "description": "ID of this connection type.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this connection type.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives/{id}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "POST",
+ "id": "dfareporting.creatives.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "ConnectionTypesListResponse": {
- "description": "Connection Type List Response",
- "id": "ConnectionTypesListResponse",
- "properties": {
- "connectionTypes": {
- "description": "Collection of connection types such as broadband and mobile.",
- "items": {
- "$ref": "ConnectionType"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
- "type": "string"
- }
+ "advertiserId": {
+ "description": "Select only creatives with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ContentCategoriesListResponse": {
- "description": "Content Category List Response",
- "id": "ContentCategoriesListResponse",
- "properties": {
- "contentCategories": {
- "description": "Content category collection.",
- "items": {
- "$ref": "ContentCategory"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "archived": {
+ "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "ContentCategory": {
- "description": "Organizes placements according to the contents of their associated webpages.",
- "id": "ContentCategory",
- "properties": {
- "accountId": {
- "description": "Account ID of this content category. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this content category. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.",
- "type": "string"
- }
+ "campaignId": {
+ "description": "Select only creatives with this campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Conversion": {
- "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
- "id": "Conversion",
- "properties": {
- "childDirectedTreatment": {
- "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
- "type": "boolean"
- },
- "customVariables": {
- "description": "Custom floodlight variables.",
- "items": {
- "$ref": "CustomFloodlightVariable"
- },
- "type": "array"
- },
- "encryptedUserId": {
- "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
- "type": "string"
- },
- "encryptedUserIdCandidates": {
- "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "floodlightActivityId": {
- "description": "Floodlight Activity ID of this conversion. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight Configuration ID of this conversion. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "gclid": {
- "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is a required field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
- "type": "string"
- },
- "limitAdTracking": {
- "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
- "type": "boolean"
- },
- "matchId": {
- "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.",
- "type": "string"
- },
- "mobileDeviceId": {
- "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid is a required field.",
- "type": "string"
- },
- "nonPersonalizedAd": {
- "description": "Whether the conversion was for a non personalized ad.",
- "type": "boolean"
- },
- "ordinal": {
- "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity of the conversion.",
- "format": "int64",
- "type": "string"
- },
- "timestampMicros": {
- "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "treatmentForUnderage": {
- "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
- "type": "boolean"
- },
- "value": {
- "description": "The value of the conversion.",
- "format": "double",
- "type": "number"
- }
+ "companionCreativeIds": {
+ "description": "Select only in-stream video creatives with these companion IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionError": {
- "description": "The error code and description for a conversion that failed to insert or update.",
- "id": "ConversionError",
- "properties": {
- "code": {
- "description": "The error code.",
- "enum": [
- "INVALID_ARGUMENT",
- "INTERNAL",
- "PERMISSION_DENIED",
- "NOT_FOUND"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
- "type": "string"
- },
- "message": {
- "description": "A description of the error.",
- "type": "string"
- }
+ "creativeFieldIds": {
+ "description": "Select only creatives with these creative field IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionStatus": {
- "description": "The original conversion that was inserted or updated and whether there were any errors.",
- "id": "ConversionStatus",
- "properties": {
- "conversion": {
- "$ref": "Conversion",
- "description": "The original conversion that was inserted or updated."
- },
- "errors": {
- "description": "A list of errors related to this conversion.",
- "items": {
- "$ref": "ConversionError"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creatives with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchInsertRequest": {
- "description": "Insert Conversions Request.",
- "id": "ConversionsBatchInsertRequest",
- "properties": {
- "conversions": {
- "description": "The set of conversions to insert.",
- "items": {
- "$ref": "Conversion"
- },
- "type": "array"
- },
- "encryptionInfo": {
- "$ref": "EncryptionInfo",
- "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "ConversionsBatchInsertResponse": {
- "description": "Insert Conversions Response.",
- "id": "ConversionsBatchInsertResponse",
- "properties": {
- "hasFailures": {
- "description": "Indicates that some or all conversions failed to insert.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
- "type": "string"
- },
- "status": {
- "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
- "items": {
- "$ref": "ConversionStatus"
- },
- "type": "array"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchUpdateRequest": {
- "description": "Update Conversions Request.",
- "id": "ConversionsBatchUpdateRequest",
- "properties": {
- "conversions": {
- "description": "The set of conversions to update.",
- "items": {
- "$ref": "Conversion"
- },
- "type": "array"
- },
- "encryptionInfo": {
- "$ref": "EncryptionInfo",
- "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchUpdateResponse": {
- "description": "Update Conversions Response.",
- "id": "ConversionsBatchUpdateResponse",
- "properties": {
- "hasFailures": {
- "description": "Indicates that some or all conversions failed to update.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
- "type": "string"
- },
- "status": {
- "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.",
- "items": {
- "$ref": "ConversionStatus"
- },
- "type": "array"
- }
+ "renderingIds": {
+ "description": "Select only creatives with these rendering IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CountriesListResponse": {
- "description": "Country List Response",
- "id": "CountriesListResponse",
- "properties": {
- "countries": {
- "description": "Country collection.",
- "items": {
- "$ref": "Country"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Country": {
- "description": "Contains information about a country that can be targeted by ads.",
- "id": "Country",
- "properties": {
- "countryCode": {
- "description": "Country code.",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this country.",
- "type": "string"
- },
- "sslEnabled": {
- "description": "Whether ad serving supports secure servers in this country.",
- "type": "boolean"
- }
+ "sizeIds": {
+ "description": "Select only creatives with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "Creative": {
- "description": "Contains properties of a Creative.",
- "id": "Creative",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether the creative is active. Applicable to all creative types.",
- "type": "boolean"
- },
- "adParameters": {
- "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "type": "string"
- },
- "adTagKeys": {
- "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "allowScriptAccess": {
- "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
- "type": "boolean"
- },
- "archived": {
- "description": "Whether the creative is archived. Applicable to all creative types.",
- "type": "boolean"
- },
- "artworkType": {
- "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "authoringSource": {
- "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
- "enum": [
- "CREATIVE_AUTHORING_SOURCE_DCM",
- "CREATIVE_AUTHORING_SOURCE_DBM",
- "CREATIVE_AUTHORING_SOURCE_STUDIO",
- "CREATIVE_AUTHORING_SOURCE_GWD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "authoringTool": {
- "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "enum": [
- "NINJA",
- "SWIFFY"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "autoAdvanceImages": {
- "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
- "type": "boolean"
- },
- "backgroundColor": {
- "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
- "type": "string"
- },
- "backupImageClickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE."
- },
- "backupImageFeatures": {
- "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "backupImageReportingLabel": {
- "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "string"
- },
- "backupImageTargetWindow": {
- "$ref": "TargetWindow",
- "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
- },
- "clickTags": {
- "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "$ref": "ClickTag"
- },
- "type": "array"
- },
- "commercialId": {
- "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.",
- "type": "string"
- },
- "companionCreatives": {
- "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "compatibility": {
- "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ",
- "items": {
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "convertFlashToHtml5": {
- "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "boolean"
- },
- "counterCustomEvents": {
- "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "creativeAssetSelection": {
- "$ref": "CreativeAssetSelection",
- "description": "Required if dynamicAssetSelection is true."
- },
- "creativeAssets": {
- "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
- "items": {
- "$ref": "CreativeAsset"
- },
- "type": "array"
- },
- "creativeFieldAssignments": {
- "description": "Creative field assignments for this creative. Applicable to all creative types.",
- "items": {
- "$ref": "CreativeFieldAssignment"
- },
- "type": "array"
- },
- "customKeyValues": {
- "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dynamicAssetSelection": {
- "description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.",
- "type": "boolean"
- },
- "exitCustomEvents": {
- "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "fsCommand": {
- "$ref": "FsCommand",
- "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
- },
- "htmlCode": {
- "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
- "type": "string"
- },
- "htmlCodeLocked": {
- "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
- },
- "latestTraffickedCreativeId": {
- "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "mediaDescription": {
- "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
- "type": "string"
- },
- "mediaDuration": {
- "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "name": {
- "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.",
- "type": "string"
- },
- "overrideCss": {
- "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO."
- },
- "redirectUrl": {
- "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT",
- "type": "string"
- },
- "renderingId": {
- "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "renderingIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "requiredFlashPluginVersion": {
- "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "type": "string"
- },
- "requiredFlashVersion": {
- "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "format": "int32",
- "type": "integer"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO."
- },
- "skippable": {
- "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.",
- "type": "boolean"
- },
- "sslCompliant": {
- "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.",
- "type": "boolean"
- },
- "sslOverride": {
- "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
- "type": "boolean"
- },
- "studioAdvertiserId": {
- "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "studioCreativeId": {
- "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "studioTraffickedCreativeId": {
- "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "thirdPartyBackupImageImpressionsUrl": {
- "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "thirdPartyRichMediaImpressionsUrl": {
- "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "thirdPartyUrls": {
- "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
- "items": {
- "$ref": "ThirdPartyTrackingUrl"
- },
- "type": "array"
- },
- "timerCustomEvents": {
- "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "totalFileSize": {
- "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.",
- "enum": [
- "IMAGE",
- "DISPLAY_REDIRECT",
- "CUSTOM_DISPLAY",
- "INTERNAL_REDIRECT",
- "CUSTOM_DISPLAY_INTERSTITIAL",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "TRACKING_TEXT",
- "RICH_MEDIA_DISPLAY_BANNER",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_DISPLAY_EXPANDING",
- "RICH_MEDIA_DISPLAY_INTERSTITIAL",
- "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
- "RICH_MEDIA_MOBILE_IN_APP",
- "FLASH_INPAGE",
- "INSTREAM_VIDEO",
- "VPAID_LINEAR_VIDEO",
- "VPAID_NON_LINEAR_VIDEO",
- "INSTREAM_VIDEO_REDIRECT",
- "RICH_MEDIA_PEEL_DOWN",
- "HTML5_BANNER",
- "DISPLAY",
- "DISPLAY_IMAGE_GALLERY",
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "INSTREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "universalAdId": {
- "$ref": "UniversalAdId",
- "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
- },
- "version": {
- "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
- "format": "int32",
- "type": "integer"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAsset": {
- "description": "Creative Asset.",
- "id": "CreativeAsset",
- "properties": {
- "actionScript3": {
- "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "boolean"
- },
- "active": {
- "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "type": "boolean"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "alignment": {
- "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .",
- "enum": [
- "ALIGNMENT_TOP",
- "ALIGNMENT_RIGHT",
- "ALIGNMENT_BOTTOM",
- "ALIGNMENT_LEFT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "artworkType": {
- "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "audioBitRate": {
- "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "audioSampleRate": {
- "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "backupImageExit": {
- "$ref": "CreativeCustomEvent",
- "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
- },
- "bitRate": {
- "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "childAssetType": {
- "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "enum": [
- "CHILD_ASSET_TYPE_FLASH",
- "CHILD_ASSET_TYPE_VIDEO",
- "CHILD_ASSET_TYPE_IMAGE",
- "CHILD_ASSET_TYPE_DATA"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "collapsedSize": {
- "$ref": "Size",
- "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "companionCreativeIds": {
- "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "customStartTimeValue": {
- "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
- "format": "int32",
- "type": "integer"
- },
- "detectedFeatures": {
- "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "displayType": {
- "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DISPLAY_TYPE_INPAGE",
- "ASSET_DISPLAY_TYPE_FLOATING",
- "ASSET_DISPLAY_TYPE_OVERLAY",
- "ASSET_DISPLAY_TYPE_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
- "ASSET_DISPLAY_TYPE_PEEL_DOWN",
- "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
- "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
- "ASSET_DISPLAY_TYPE_BACKDROP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "duration": {
- "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- },
- "durationType": {
- "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DURATION_TYPE_AUTO",
- "ASSET_DURATION_TYPE_NONE",
- "ASSET_DURATION_TYPE_CUSTOM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "expandedDimension": {
- "$ref": "Size",
- "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "fileSize": {
- "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64",
- "type": "string"
- },
- "flashVersion": {
- "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "format": "int32",
- "type": "integer"
- },
- "frameRate": {
- "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "hideFlashObjects": {
- "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "hideSelectionBoxes": {
- "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "horizontallyLocked": {
- "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "id": {
- "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
- },
- "mediaDuration": {
- "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "mimeType": {
- "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "orientation": {
- "description": "Orientation of video asset. This is a read-only, auto-generated field.",
- "enum": [
- "LANDSCAPE",
- "PORTRAIT",
- "SQUARE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "originalBackup": {
- "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "politeLoad": {
- "description": "Whether this asset is used as a polite load asset.",
- "type": "boolean"
- },
- "position": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "positionLeftUnit": {
- "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "positionTopUnit": {
- "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "progressiveServingUrl": {
- "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "pushdown": {
- "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
- "type": "boolean"
- },
- "pushdownDuration": {
- "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
- "format": "float",
- "type": "number"
- },
- "role": {
- "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
- "enum": [
- "PRIMARY",
- "BACKUP_IMAGE",
- "ADDITIONAL_IMAGE",
- "ADDITIONAL_FLASH",
- "PARENT_VIDEO",
- "TRANSCODED_VIDEO",
- "OTHER",
- "ALTERNATE_VIDEO",
- "PARENT_AUDIO",
- "TRANSCODED_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
- },
- "sslCompliant": {
- "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "type": "boolean"
- },
- "startTimeType": {
- "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_START_TIME_TYPE_NONE",
- "ASSET_START_TIME_TYPE_CUSTOM"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "streamingServingUrl": {
- "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "transparency": {
- "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.",
- "type": "boolean"
- },
- "verticallyLocked": {
- "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "windowMode": {
- "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
- "enum": [
- "OPAQUE",
- "WINDOW",
- "TRANSPARENT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "zIndex": {
- "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "zipFilename": {
- "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "type": "string"
- },
- "zipFilesize": {
- "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAssetId": {
- "description": "Creative Asset ID.",
- "id": "CreativeAssetId",
- "properties": {
- "name": {
- "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
- "type": "string"
- },
- "type": {
- "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
- "enum": [
- "IMAGE",
- "FLASH",
- "VIDEO",
- "HTML",
- "HTML_IMAGE",
- "AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "studioCreativeId": {
+ "description": "Select only creatives corresponding to this Studio creative ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAssetMetadata": {
- "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
- "id": "CreativeAssetMetadata",
- "properties": {
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "ID of the creative asset. This is a required field."
- },
- "clickTags": {
- "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
- "items": {
- "$ref": "ClickTag"
- },
- "type": "array"
- },
- "detectedFeatures": {
- "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
- "type": "string"
- },
- "warnedValidationRules": {
- "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
- "items": {
- "enum": [
- "CLICK_TAG_NON_TOP_LEVEL",
- "CLICK_TAG_MISSING",
- "CLICK_TAG_MORE_THAN_ONE",
- "CLICK_TAG_INVALID",
- "ORPHANED_ASSET",
- "PRIMARY_HTML_MISSING",
- "EXTERNAL_FILE_REFERENCED",
- "MRAID_REFERENCED",
- "ADMOB_REFERENCED",
- "FILE_TYPE_INVALID",
- "ZIP_INVALID",
- "LINKED_FILE_NOT_FOUND",
- "MAX_FLASH_VERSION_11",
- "NOT_SSL_COMPLIANT",
- "FILE_DETAIL_EMPTY",
- "ASSET_INVALID",
- "GWD_PROPERTIES_INVALID",
- "ENABLER_UNSUPPORTED_METHOD_DCM",
- "ASSET_FORMAT_UNSUPPORTED_DCM",
- "COMPONENT_UNSUPPORTED_DCM",
- "HTML5_FEATURE_UNSUPPORTED",
- "CLICK_TAG_IN_GWD",
- "CLICK_TAG_HARD_CODED",
- "SVG_INVALID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- }
+ "types": {
+ "description": "Select only creatives with these creative types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "response": {
+ "$ref": "CreativesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creatives.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAssetSelection": {
- "description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
- "id": "CreativeAssetSelection",
- "properties": {
- "defaultAssetId": {
- "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "rules": {
- "description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creatives.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "dimensionValues": {
+ "methods": {
+ "query": {
+ "description": "Retrieves list of report dimension values for a list of filters.",
+ "flatPath": "userprofiles/{profileId}/dimensionvalues/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.dimensionValues.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "100",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "CreativeAssignment": {
- "description": "Creative Assignment.",
- "id": "CreativeAssignment",
- "properties": {
- "active": {
- "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.",
- "type": "boolean"
- },
- "applyEventTags": {
- "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
- "type": "boolean"
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of the creative assignment."
- },
- "companionCreativeOverrides": {
- "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
- "items": {
- "$ref": "CompanionClickThroughOverride"
- },
- "type": "array"
- },
- "creativeGroupAssignments": {
- "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- },
- "type": "array"
- },
- "creativeId": {
- "description": "ID of the creative to be assigned. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "creativeIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
- },
- "endTime": {
- "format": "date-time",
- "type": "string"
- },
- "richMediaExitOverrides": {
- "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
- "items": {
- "$ref": "RichMediaExitOverride"
- },
- "type": "array"
- },
- "sequence": {
- "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "sslCompliant": {
- "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "startTime": {
- "format": "date-time",
- "type": "string"
- },
- "weight": {
- "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- }
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeClickThroughUrl": {
- "description": "Click-through URL",
- "id": "CreativeClickThroughUrl",
- "properties": {
- "computedClickThroughUrl": {
- "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
- "type": "string"
- },
- "customClickThroughUrl": {
- "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
- "type": "string"
- },
- "landingPageId": {
- "description": "ID of the landing page for the click-through URL.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dimensionvalues/query",
+ "request": {
+ "$ref": "DimensionValueRequest"
+ },
+ "response": {
+ "$ref": "DimensionValueList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "directorySites": {
+ "methods": {
+ "get": {
+ "description": "Gets one directory site by ID.",
+ "flatPath": "userprofiles/{profileId}/directorySites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Directory site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeCustomEvent": {
- "description": "Creative Custom Event.",
- "id": "CreativeCustomEvent",
- "properties": {
- "advertiserCustomEventId": {
- "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserCustomEventName": {
- "description": "User-entered name for the event.",
- "type": "string"
- },
- "advertiserCustomEventType": {
- "description": "Type of the event. This is a read-only field.",
- "enum": [
- "ADVERTISER_EVENT_TIMER",
- "ADVERTISER_EVENT_EXIT",
- "ADVERTISER_EVENT_COUNTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "artworkLabel": {
- "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
- "type": "string"
- },
- "artworkType": {
- "description": "Artwork type used by the creative.This is a read-only field.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "exitClickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Exit click-through URL for the event. This field is used only for exit events."
- },
- "id": {
- "description": "ID of this event. This is a required field and should not be modified after insertion.",
- "format": "int64",
- "type": "string"
- },
- "popupWindowProperties": {
- "$ref": "PopupWindowProperties",
- "description": "Properties for rich media popup windows. This field is used only for exit events."
- },
- "targetType": {
- "description": "Target type used by the event.",
- "enum": [
- "TARGET_BLANK",
- "TARGET_TOP",
- "TARGET_SELF",
- "TARGET_PARENT",
- "TARGET_POPUP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "videoReportingId": {
- "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites/{id}",
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new directory site.",
+ "flatPath": "userprofiles/{profileId}/directorySites",
+ "httpMethod": "POST",
+ "id": "dfareporting.directorySites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites",
+ "request": {
+ "$ref": "DirectorySite"
+ },
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/directorySites",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeField": {
- "description": "Contains properties of a creative field.",
- "id": "CreativeField",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative field. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this creative field. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeFieldAssignment": {
- "description": "Creative Field Assignment.",
- "id": "CreativeFieldAssignment",
- "properties": {
- "creativeFieldId": {
- "description": "ID of the creative field.",
- "format": "int64",
- "type": "string"
- },
- "creativeFieldValueId": {
- "description": "ID of the creative field value.",
- "format": "int64",
- "type": "string"
- }
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeFieldValue": {
- "description": "Contains properties of a creative field value.",
- "id": "CreativeFieldValue",
- "properties": {
- "id": {
- "description": "ID of this creative field value. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
- "type": "string"
- },
- "value": {
- "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
- "type": "string"
- }
+ "active": {
+ "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeFieldValuesListResponse": {
- "description": "Creative Field Value List Response",
- "id": "CreativeFieldValuesListResponse",
- "properties": {
- "creativeFieldValues": {
- "description": "Creative field value collection.",
- "items": {
- "$ref": "CreativeFieldValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "dfpNetworkCode": {
+ "description": "Select only directory sites with this Ad Manager network code.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeFieldsListResponse": {
- "description": "Creative Field List Response",
- "id": "CreativeFieldsListResponse",
- "properties": {
- "creativeFields": {
- "description": "Creative field collection.",
- "items": {
- "$ref": "CreativeField"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only directory sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeGroup": {
- "description": "Contains properties of a creative group.",
- "id": "CreativeGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative group. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "groupNumber": {
- "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "ID of this creative group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "CreativeGroupAssignment": {
- "description": "Creative Group Assignment.",
- "id": "CreativeGroupAssignment",
- "properties": {
- "creativeGroupId": {
- "description": "ID of the creative group to be assigned.",
- "format": "int64",
- "type": "string"
- },
- "creativeGroupNumber": {
- "description": "Creative group number of the creative group assignment.",
- "enum": [
- "CREATIVE_GROUP_ONE",
- "CREATIVE_GROUP_TWO"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeGroupsListResponse": {
- "description": "Creative Group List Response",
- "id": "CreativeGroupsListResponse",
- "properties": {
- "creativeGroups": {
- "description": "Creative group collection.",
- "items": {
- "$ref": "CreativeGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeOptimizationConfiguration": {
- "description": "Creative optimization settings.",
- "id": "CreativeOptimizationConfiguration",
- "properties": {
- "id": {
- "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.",
- "type": "string"
- },
- "optimizationActivitys": {
- "description": "List of optimization activities associated with this configuration.",
- "items": {
- "$ref": "OptimizationActivity"
- },
- "type": "array"
- },
- "optimizationModel": {
- "description": "Optimization model for this configuration.",
- "enum": [
- "CLICK",
- "POST_CLICK",
- "POST_IMPRESSION",
- "POST_CLICK_AND_IMPRESSION",
- "VIDEO_COMPLETION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeRotation": {
- "description": "Creative Rotation.",
- "id": "CreativeRotation",
- "properties": {
- "creativeAssignments": {
- "description": "Creative assignments in this creative rotation.",
- "items": {
- "$ref": "CreativeAssignment"
- },
- "type": "array"
- },
- "creativeOptimizationConfigurationId": {
- "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
- "enum": [
- "CREATIVE_ROTATION_TYPE_SEQUENTIAL",
- "CREATIVE_ROTATION_TYPE_RANDOM"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "weightCalculationStrategy": {
- "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
- "enum": [
- "WEIGHT_STRATEGY_EQUAL",
- "WEIGHT_STRATEGY_CUSTOM",
- "WEIGHT_STRATEGY_HIGHEST_CTR",
- "WEIGHT_STRATEGY_OPTIMIZED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativesListResponse": {
- "description": "Creative List Response",
- "id": "CreativesListResponse",
- "properties": {
- "creatives": {
- "description": "Creative collection.",
- "items": {
- "$ref": "Creative"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites",
+ "response": {
+ "$ref": "DirectorySitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "dynamicTargetingKeys": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing dynamic targeting key.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.dynamicTargetingKeys.delete",
+ "parameterOrder": [
+ "profileId",
+ "objectId",
+ "name",
+ "objectType"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CrossDimensionReachReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "id": "CrossDimensionReachReportCompatibleFields",
- "properties": {
- "breakdown": {
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "overlapMetrics": {
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomFloodlightVariable": {
- "description": "A custom floodlight variable.",
- "id": "CustomFloodlightVariable",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
- "type": "string"
- },
- "type": {
- "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.",
- "type": "string"
- }
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomRichMediaEvents": {
- "description": "Represents a Custom Rich Media Events group.",
- "id": "CustomRichMediaEvents",
- "properties": {
- "filteredEventIds": {
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "POST",
+ "id": "dfareporting.dynamicTargetingKeys.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "request": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "response": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of dynamic targeting keys.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "GET",
+ "id": "dfareporting.dynamicTargetingKeys.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomViewabilityMetric": {
- "description": "Custom Viewability Metric",
- "id": "CustomViewabilityMetric",
- "properties": {
- "configuration": {
- "$ref": "CustomViewabilityMetricConfiguration",
- "description": "Configuration of the custom viewability metric."
- },
- "id": {
- "description": "ID of the custom viewability metric.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of the custom viewability metric.",
- "type": "string"
- }
+ "names": {
+ "description": "Select only dynamic targeting keys exactly matching these names.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomViewabilityMetricConfiguration": {
- "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
- "id": "CustomViewabilityMetricConfiguration",
- "properties": {
- "audible": {
- "description": "Whether the video must be audible to count an impression.",
- "type": "boolean"
- },
- "timeMillis": {
- "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.",
- "format": "int32",
- "type": "integer"
- },
- "timePercent": {
- "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
- "format": "int32",
- "type": "integer"
- },
- "viewabilityPercent": {
- "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.",
- "format": "int32",
- "type": "integer"
- }
+ "objectId": {
+ "description": "Select only dynamic targeting keys with this object ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DateRange": {
- "description": "Represents a date range.",
- "id": "DateRange",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "type": "string"
- },
- "relativeDateRange": {
- "description": "The date range relative to the date of when the report is run.",
- "enum": [
- "TODAY",
- "YESTERDAY",
- "WEEK_TO_DATE",
- "MONTH_TO_DATE",
- "QUARTER_TO_DATE",
- "YEAR_TO_DATE",
- "PREVIOUS_WEEK",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_YEAR",
- "LAST_7_DAYS",
- "LAST_30_DAYS",
- "LAST_90_DAYS",
- "LAST_365_DAYS",
- "LAST_24_MONTHS",
- "LAST_14_DAYS",
- "LAST_60_DAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
+ "objectType": {
+ "description": "Select only dynamic targeting keys with this object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DayPartTargeting": {
- "description": "Day Part Targeting.",
- "id": "DayPartTargeting",
- "properties": {
- "daysOfWeek": {
- "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ",
- "items": {
- "enum": [
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "hoursOfDay": {
- "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "userLocalTime": {
- "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "response": {
+ "$ref": "DynamicTargetingKeysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "eventTags": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.eventTags.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DeepLink": {
- "description": "Contains information about a landing page deep link.",
- "id": "DeepLink",
- "properties": {
- "appUrl": {
- "description": "The URL of the mobile app being linked to.",
- "type": "string"
- },
- "fallbackUrl": {
- "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".",
- "type": "string"
- },
- "mobileApp": {
- "$ref": "MobileApp",
- "description": "The mobile app targeted by this deep link."
- },
- "remarketingListIds": {
- "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one event tag by ID.",
+ "flatPath": "userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DefaultClickThroughEventTagProperties": {
- "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
- "id": "DefaultClickThroughEventTagProperties",
- "properties": {
- "defaultClickThroughEventTagId": {
- "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
- "format": "int64",
- "type": "string"
- },
- "overrideInheritedEventTag": {
- "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags/{id}",
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "POST",
+ "id": "dfareporting.eventTags.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of event tags, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "adId": {
+ "description": "Select only event tags that belong to this ad.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DeliverySchedule": {
- "description": "Delivery Schedule.",
- "id": "DeliverySchedule",
- "properties": {
- "frequencyCap": {
- "$ref": "FrequencyCap",
- "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
- },
- "hardCutoff": {
- "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.",
- "type": "boolean"
- },
- "impressionRatio": {
- "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "priority": {
- "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
- "enum": [
- "AD_PRIORITY_01",
- "AD_PRIORITY_02",
- "AD_PRIORITY_03",
- "AD_PRIORITY_04",
- "AD_PRIORITY_05",
- "AD_PRIORITY_06",
- "AD_PRIORITY_07",
- "AD_PRIORITY_08",
- "AD_PRIORITY_09",
- "AD_PRIORITY_10",
- "AD_PRIORITY_11",
- "AD_PRIORITY_12",
- "AD_PRIORITY_13",
- "AD_PRIORITY_14",
- "AD_PRIORITY_15",
- "AD_PRIORITY_16"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "advertiserId": {
+ "description": "Select only event tags that belong to this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DfpSettings": {
- "description": "Google Ad Manager Settings",
- "id": "DfpSettings",
- "properties": {
- "dfpNetworkCode": {
- "description": "Ad Manager network code for this directory site.",
- "type": "string"
- },
- "dfpNetworkName": {
- "description": "Ad Manager network name for this directory site.",
- "type": "string"
- },
- "programmaticPlacementAccepted": {
- "description": "Whether this directory site accepts programmatic placements.",
- "type": "boolean"
- },
- "pubPaidPlacementAccepted": {
- "description": "Whether this directory site accepts publisher-paid tags.",
- "type": "boolean"
- },
- "publisherPortalOnly": {
- "description": "Whether this directory site is available only via Publisher Portal.",
- "type": "boolean"
- }
+ "campaignId": {
+ "description": "Select only event tags that belong to this campaign.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Dimension": {
- "description": "Represents a dimension.",
- "id": "Dimension",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "type": "string"
- },
- "name": {
- "description": "The dimension name, e.g. dfa:advertiser",
- "type": "string"
- }
+ "definitionsOnly": {
+ "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "DimensionFilter": {
- "description": "Represents a dimension filter.",
- "id": "DimensionFilter",
- "properties": {
- "dimensionName": {
- "description": "The name of the dimension to filter.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "type": "string"
- },
- "value": {
- "description": "The value of the dimension to filter.",
- "type": "string"
- }
+ "enabled": {
+ "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "DimensionValue": {
- "description": "Represents a DimensionValue resource.",
- "id": "DimensionValue",
- "properties": {
- "dimensionName": {
- "description": "The name of the dimension.",
- "type": "string"
- },
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "id": {
- "description": "The ID associated with the value if available.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "type": "string"
- },
- "matchType": {
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "EXACT",
- "BEGINS_WITH",
- "CONTAINS",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "The value of the dimension.",
- "type": "string"
- }
+ "eventTagTypes": {
+ "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "DimensionValueList": {
- "description": "Represents the list of DimensionValue resources.",
- "id": "DimensionValueList",
- "properties": {
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "items": {
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only event tags with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "DimensionValueRequest": {
- "description": "Represents a DimensionValuesRequest.",
- "id": "DimensionValueRequest",
- "properties": {
- "dimensionName": {
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- },
- "description": "The name of the dimension for which values should be requested.",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "filters": {
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySite": {
- "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
- "id": "DirectorySite",
- "properties": {
- "active": {
- "description": "Whether this directory site is active.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this directory site. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
- },
- "inpageTagFormats": {
- "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ",
- "items": {
- "enum": [
- "STANDARD",
- "IFRAME_JAVASCRIPT_INPAGE",
- "INTERNAL_REDIRECT_INPAGE",
- "JAVASCRIPT_INPAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "interstitialTagFormats": {
- "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ",
- "items": {
- "enum": [
- "IFRAME_JAVASCRIPT_INTERSTITIAL",
- "INTERNAL_REDIRECT_INTERSTITIAL",
- "JAVASCRIPT_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this directory site.",
- "type": "string"
- },
- "settings": {
- "$ref": "DirectorySiteSettings",
- "description": "Directory site settings."
- },
- "url": {
- "description": "URL of this directory site.",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySiteSettings": {
- "description": "Directory Site Settings",
- "id": "DirectorySiteSettings",
- "properties": {
- "activeViewOptOut": {
- "description": "Whether this directory site has disabled active view creatives.",
- "type": "boolean"
- },
- "dfpSettings": {
- "$ref": "DfpSettings",
- "description": "Directory site Ad Manager settings."
- },
- "instreamVideoPlacementAccepted": {
- "description": "Whether this site accepts in-stream video ads.",
- "type": "boolean"
- },
- "interstitialPlacementAccepted": {
- "description": "Whether this site accepts interstitial ads.",
- "type": "boolean"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySitesListResponse": {
- "description": "Directory Site List Response",
- "id": "DirectorySitesListResponse",
- "properties": {
- "directorySites": {
- "description": "Directory site collection.",
- "items": {
- "$ref": "DirectorySite"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "response": {
+ "$ref": "EventTagsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing event tag. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.eventTags.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "EventTag ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DynamicTargetingKey": {
- "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
- "id": "DynamicTargetingKey",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this dynamic targeting key. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "objectType": {
- "description": "Type of the object of this dynamic targeting key. This is a required field.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "PUT",
+ "id": "dfareporting.eventTags.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.get",
+ "parameterOrder": [
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DynamicTargetingKeysListResponse": {
- "description": "Dynamic Targeting Key List Response",
- "id": "DynamicTargetingKeysListResponse",
- "properties": {
- "dynamicTargetingKeys": {
- "description": "Dynamic targeting key collection.",
- "items": {
- "$ref": "DynamicTargetingKey"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
- "type": "string"
- }
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
+ },
+ "list": {
+ "description": "Lists files for a user profile.",
+ "flatPath": "userprofiles/{profileId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "EncryptionInfo": {
- "description": "A description of how user IDs are encrypted.",
- "id": "EncryptionInfo",
- "properties": {
- "encryptionEntityId": {
- "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
- "format": "int64",
- "type": "string"
- },
- "encryptionEntityType": {
- "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
- "enum": [
- "ENCRYPTION_ENTITY_TYPE_UNKNOWN",
- "DCM_ACCOUNT",
- "DCM_ADVERTISER",
- "DBM_PARTNER",
- "DBM_ADVERTISER",
- "ADWORDS_CUSTOMER",
- "DFP_NETWORK_CODE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "encryptionSource": {
- "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
- "enum": [
- "ENCRYPTION_SCOPE_UNKNOWN",
- "AD_SERVING",
- "DATA_TRANSFER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
- "type": "string"
- }
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "EventTag": {
- "description": "Contains properties of an event tag.",
- "id": "EventTag",
- "properties": {
- "accountId": {
- "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "campaignId": {
- "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "enabledByDefault": {
- "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.",
- "type": "boolean"
- },
- "excludeFromAdxRequests": {
- "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this event tag. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this event tag. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "siteFilterType": {
- "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
- "enum": [
- "WHITELIST",
- "BLACKLIST"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "siteIds": {
- "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "sslCompliant": {
- "description": "Whether this tag is SSL-compliant or not. This is a read-only field.",
- "type": "boolean"
- },
- "status": {
- "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
- "enum": [
- "ENABLED",
- "DISABLED"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
- "enum": [
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG",
- "CLICK_THROUGH_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "url": {
- "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.",
- "type": "string"
- },
- "urlEscapeLevels": {
- "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
- "format": "int32",
- "type": "integer"
- }
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "EventTagOverride": {
- "description": "Event tag override information.",
- "id": "EventTagOverride",
- "properties": {
- "enabled": {
- "description": "Whether this override is enabled.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this event tag override. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- }
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE",
+ "SHARED_WITH_ME"
+ ],
+ "enumDescriptions": [
+ "All files in account.",
+ "My files.",
+ "Files shared with me."
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "EventTagsListResponse": {
- "description": "Event Tag List Response",
- "id": "EventTagsListResponse",
- "properties": {
- "eventTags": {
- "description": "Event tag collection.",
- "items": {
- "$ref": "EventTag"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
- "type": "string"
- }
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "Sort by file ID.",
+ "Sort by 'lastmodifiedAt' field."
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "File": {
- "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "id": "File",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "fileName": {
- "description": "The filename of the file.",
- "type": "string"
- },
- "format": {
- "description": "The output format of the report. Only available once the file is available.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "The unique ID of this report file.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
- "type": "string"
- },
- "lastModifiedTime": {
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64",
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report this file was generated from.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "description": "The status of the report file.",
- "enum": [
- "PROCESSING",
- "REPORT_AVAILABLE",
- "FAILED",
- "CANCELLED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "urls": {
- "description": "The URLs where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "description": "The URL for downloading the report data through the API.",
- "type": "string"
- },
- "browserUrl": {
- "description": "The URL for downloading the report data through a browser.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "floodlightActivities": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.floodlightActivities.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FileList": {
- "description": "List of files for a report.",
- "id": "FileList",
- "properties": {
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "items": {
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "generatetag": {
+ "description": "Generates a tag for a floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/generatetag",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.generatetag",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID for which we want to generate a tag.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Flight": {
- "description": "Flight",
- "id": "Flight",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "rateOrCost": {
- "description": "Rate or cost of this flight.",
- "format": "int64",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "units": {
- "description": "Units of this flight.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
+ "response": {
+ "$ref": "FloodlightActivitiesGenerateTagResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one floodlight activity by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivitiesGenerateTagResponse": {
- "description": "Floodlight Activity GenerateTag Response",
- "id": "FloodlightActivitiesGenerateTagResponse",
- "properties": {
- "floodlightActivityTag": {
- "description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
- "type": "string"
- },
- "globalSiteTagGlobalSnippet": {
- "description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivitiesListResponse": {
- "description": "Floodlight Activity List Response",
- "id": "FloodlightActivitiesListResponse",
- "properties": {
- "floodlightActivities": {
- "description": "Floodlight activity collection.",
- "items": {
- "$ref": "FloodlightActivity"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "floodlightActivityGroupIds": {
+ "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivity": {
- "description": "Contains properties of a Floodlight activity.",
- "id": "FloodlightActivity",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "cacheBustingType": {
- "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
- "enum": [
- "JAVASCRIPT",
- "ACTIVE_SERVER_PAGE",
- "JSP",
- "PHP",
- "COLD_FUSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "countingMethod": {
- "description": "Counting method for conversions for this floodlight activity. This is a required field.",
- "enum": [
- "STANDARD_COUNTING",
- "UNIQUE_COUNTING",
- "SESSION_COUNTING",
- "TRANSACTIONS_COUNTING",
- "ITEMS_SOLD_COUNTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "defaultTags": {
- "description": "Dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityDynamicTag"
- },
- "type": "array"
- },
- "expectedUrl": {
- "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
- "type": "string"
- },
- "floodlightActivityGroupId": {
- "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityGroupName": {
- "description": "Name of the associated floodlight activity group. This is a read-only field.",
- "type": "string"
- },
- "floodlightActivityGroupTagString": {
- "description": "Tag string of the associated floodlight activity group. This is a read-only field.",
- "type": "string"
- },
- "floodlightActivityGroupType": {
- "description": "Type of the associated floodlight activity group. This is a read-only field.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "floodlightTagType": {
- "description": "The type of Floodlight tag this activity will generate. This is a required field.",
- "enum": [
- "IFRAME",
- "IMAGE",
- "GLOBAL_SITE_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "hidden": {
- "description": "Whether this activity is archived.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.",
- "type": "string"
- },
- "notes": {
- "description": "General notes or implementation instructions for the tag.",
- "type": "string"
- },
- "publisherTags": {
- "description": "Publisher dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityPublisherDynamicTag"
- },
- "type": "array"
- },
- "secure": {
- "description": "Whether this tag should use SSL.",
- "type": "boolean"
- },
- "sslCompliant": {
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Whether this floodlight activity must be SSL-compliant.",
- "type": "boolean"
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagFormat": {
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
- "enum": [
- "HTML",
- "XHTML"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "tagString": {
- "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
- "type": "string"
- },
- "userDefinedVariableTypes": {
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
- "items": {
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- }
+ "floodlightActivityGroupName": {
+ "description": "Select only floodlight activities with the specified floodlight activity group name.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityDynamicTag": {
- "description": "Dynamic Tag",
- "id": "FloodlightActivityDynamicTag",
- "properties": {
- "id": {
- "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this tag.",
- "type": "string"
- },
- "tag": {
- "description": "Tag code.",
- "type": "string"
- }
+ "floodlightActivityGroupTagString": {
+ "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityGroup": {
- "description": "Contains properties of a Floodlight activity group.",
- "id": "FloodlightActivityGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagString": {
- "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
- "type": "string"
- },
- "type": {
- "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "floodlightActivityGroupType": {
+ "description": "Select only floodlight activities with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityGroupsListResponse": {
- "description": "Floodlight Activity Group List Response",
- "id": "FloodlightActivityGroupsListResponse",
- "properties": {
- "floodlightActivityGroups": {
- "description": "Floodlight activity group collection.",
- "items": {
- "$ref": "FloodlightActivityGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityPublisherDynamicTag": {
- "description": "Publisher Dynamic Tag",
- "id": "FloodlightActivityPublisherDynamicTag",
- "properties": {
- "clickThrough": {
- "description": "Whether this tag is applicable only for click-throughs.",
- "type": "boolean"
- },
- "directorySiteId": {
- "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
- "format": "int64",
- "type": "string"
- },
- "dynamicTag": {
- "$ref": "FloodlightActivityDynamicTag",
- "description": "Dynamic floodlight tag."
- },
- "siteId": {
- "description": "Site ID of this dynamic tag.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "viewThrough": {
- "description": "Whether this tag is applicable only for view-throughs.",
- "type": "boolean"
- }
+ "ids": {
+ "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightConfiguration": {
- "description": "Contains properties of a Floodlight configuration.",
- "id": "FloodlightConfiguration",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "analyticsDataSharingEnabled": {
- "description": "Whether advertiser data is shared with Google Analytics.",
- "type": "boolean"
- },
- "customViewabilityMetric": {
- "$ref": "CustomViewabilityMetric",
- "description": "Custom Viewability metric for the floodlight configuration."
- },
- "exposureToConversionEnabled": {
- "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
- "type": "boolean"
- },
- "firstDayOfWeek": {
- "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
- "enum": [
- "MONDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
- },
- "inAppAttributionTrackingEnabled": {
- "description": "Whether in-app attribution tracking is enabled.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
- "type": "string"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this floodlight configuration."
- },
- "naturalSearchConversionAttributionOption": {
- "description": "Types of attribution options for natural search conversions.",
- "enum": [
- "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "omnitureSettings": {
- "$ref": "OmnitureSettings",
- "description": "Settings for Campaign Manager Omniture integration."
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagSettings": {
- "$ref": "TagSettings",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "thirdPartyAuthenticationTokens": {
- "description": "List of third-party authentication tokens enabled for this configuration.",
- "items": {
- "$ref": "ThirdPartyAuthenticationToken"
- },
- "type": "array"
- },
- "userDefinedVariableConfigurations": {
- "description": "List of user defined variables enabled for this configuration.",
- "items": {
- "$ref": "UserDefinedVariableConfiguration"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "FloodlightConfigurationsListResponse": {
- "description": "Floodlight Configuration List Response",
- "id": "FloodlightConfigurationsListResponse",
- "properties": {
- "floodlightConfigurations": {
- "description": "Floodlight configuration collection.",
- "items": {
- "$ref": "FloodlightConfiguration"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "id": "FloodlightReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FrequencyCap": {
- "description": "Frequency Cap.",
- "id": "FrequencyCap",
- "properties": {
- "duration": {
- "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "impressions": {
- "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
- "format": "int64",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FsCommand": {
- "description": "FsCommand.",
- "id": "FsCommand",
- "properties": {
- "left": {
- "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32",
- "type": "integer"
- },
- "positionOption": {
- "description": "Position in the browser where the window will open.",
- "enum": [
- "CENTERED",
- "DISTANCE_FROM_TOP_LEFT_CORNER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "top": {
- "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32",
- "type": "integer"
- },
- "windowHeight": {
- "description": "Height of the window.",
- "format": "int32",
- "type": "integer"
- },
- "windowWidth": {
- "description": "Width of the window.",
- "format": "int32",
- "type": "integer"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "GeoTargeting": {
- "description": "Geographical Targeting.",
- "id": "GeoTargeting",
- "properties": {
- "cities": {
- "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
- "items": {
- "$ref": "City"
- },
- "type": "array"
- },
- "countries": {
- "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
- "items": {
- "$ref": "Country"
- },
- "type": "array"
- },
- "excludeCountries": {
- "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.",
- "type": "boolean"
- },
- "metros": {
- "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
- "items": {
- "$ref": "Metro"
- },
- "type": "array"
- },
- "postalCodes": {
- "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
- "items": {
- "$ref": "PostalCode"
- },
- "type": "array"
- },
- "regions": {
- "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "InventoryItem": {
- "description": "Represents a buy from the Planning inventory store.",
- "id": "InventoryItem",
- "properties": {
- "accountId": {
- "description": "Account ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "adSlots": {
- "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
- "items": {
- "$ref": "AdSlot"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "contentCategoryId": {
- "description": "Content category ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "estimatedClickThroughRate": {
- "description": "Estimated click-through rate of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "estimatedConversionRate": {
- "description": "Estimated conversion rate of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "inPlan": {
- "description": "Whether this inventory item is in plan.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this inventory item."
- },
- "name": {
- "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.",
- "type": "string"
- },
- "negotiationChannelId": {
- "description": "Negotiation channel ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "orderId": {
- "description": "Order ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "placementStrategyId": {
- "description": "Placement strategy ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "pricing": {
- "$ref": "Pricing",
- "description": "Pricing of this inventory item."
- },
- "projectId": {
- "description": "Project ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "rfpId": {
- "description": "RFP ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "siteId": {
- "description": "ID of the site this inventory item is associated with.",
- "format": "int64",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_TYPE_REGULAR",
- "PLANNING_PLACEMENT_TYPE_CREDIT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "tagString": {
+ "description": "Select only floodlight activities with the specified tag string.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "response": {
+ "$ref": "FloodlightActivitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivities.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivity ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "InventoryItemsListResponse": {
- "description": "Inventory item List Response",
- "id": "InventoryItemsListResponse",
- "properties": {
- "inventoryItems": {
- "description": "Inventory item collection",
- "items": {
- "$ref": "InventoryItem"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivities.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightActivityGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight activity group by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity Group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "KeyValueTargetingExpression": {
- "description": "Key Value Targeting Expression.",
- "id": "KeyValueTargetingExpression",
- "properties": {
- "expression": {
- "description": "Keyword expression being targeted by the ad.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity group.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivityGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "LandingPage": {
- "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
- "id": "LandingPage",
- "properties": {
- "advertiserId": {
- "description": "Advertiser ID of this landing page. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "archived": {
- "description": "Whether this landing page has been archived.",
- "type": "boolean"
- },
- "deepLinks": {
- "description": "Links that will direct the user to a mobile app, if installed.",
- "items": {
- "$ref": "DeepLink"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this landing page. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
- "type": "string"
- },
- "url": {
- "description": "URL of this landing page. This is a required field.",
- "type": "string"
- }
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Language": {
- "description": "Contains information about a language that can be targeted by ads.",
- "id": "Language",
- "properties": {
- "id": {
- "description": "Language ID of this language. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".",
- "type": "string"
- },
- "languageCode": {
- "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
- "type": "string"
- },
- "name": {
- "description": "Name of this language.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "LanguageTargeting": {
- "description": "Language Targeting.",
- "id": "LanguageTargeting",
- "properties": {
- "languages": {
- "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Language"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "LanguagesListResponse": {
- "description": "Language List Response",
- "id": "LanguagesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
- "type": "string"
- },
- "languages": {
- "description": "Language collection.",
- "items": {
- "$ref": "Language"
- },
- "type": "array"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "LastModifiedInfo": {
- "description": "Modification timestamp.",
- "id": "LastModifiedInfo",
- "properties": {
- "time": {
- "description": "Timestamp of the last change in milliseconds since epoch.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationClause": {
- "description": "A group clause made up of list population terms representing constraints joined by ORs.",
- "id": "ListPopulationClause",
- "properties": {
- "terms": {
- "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
- "items": {
- "$ref": "ListPopulationTerm"
- },
- "type": "array"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationRule": {
- "description": "Remarketing List Population Rule.",
- "id": "ListPopulationRule",
- "properties": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityName": {
- "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "listPopulationClauses": {
- "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
- "items": {
- "$ref": "ListPopulationClause"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationTerm": {
- "description": "Remarketing List Population Rule Term.",
- "id": "ListPopulationTerm",
- "properties": {
- "contains": {
- "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
- "type": "boolean"
- },
- "negation": {
- "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "boolean"
- },
- "operator": {
- "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "enum": [
- "NUM_EQUALS",
- "NUM_LESS_THAN",
- "NUM_LESS_THAN_EQUAL",
- "NUM_GREATER_THAN",
- "NUM_GREATER_THAN_EQUAL",
- "STRING_EQUALS",
- "STRING_CONTAINS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "remarketingListId": {
- "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
- "enum": [
- "CUSTOM_VARIABLE_TERM",
- "LIST_MEMBERSHIP_TERM",
- "REFERRER_TERM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "string"
- },
- "variableFriendlyName": {
- "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
- "type": "string"
- },
- "variableName": {
- "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ListTargetingExpression": {
- "description": "Remarketing List Targeting Expression.",
- "id": "ListTargetingExpression",
- "properties": {
- "expression": {
- "description": "Expression describing which lists are being targeted by the ad.",
- "type": "string"
- }
+ "type": {
+ "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "response": {
+ "$ref": "FloodlightActivityGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivityGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivityGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "LookbackConfiguration": {
- "description": "Lookback configuration settings.",
- "id": "LookbackConfiguration",
- "properties": {
- "clickDuration": {
- "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "postImpressionActivitiesDuration": {
- "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
- "format": "int32",
- "type": "integer"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity group.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivityGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightConfigurations": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight configuration by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight configuration ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Metric": {
- "description": "Represents a metric.",
- "id": "Metric",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "type": "string"
- },
- "name": {
- "description": "The metric name, e.g. dfa:impressions",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight configurations, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "Metro": {
- "description": "Contains information about a metro region that can be targeted by ads.",
- "id": "Metro",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this metro region belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this metro region belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this metro region.",
- "format": "int64",
- "type": "string"
- },
- "dmaId": {
- "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
- "type": "string"
- },
- "metroCode": {
- "description": "Metro code of this metro region. This is equivalent to dma_id.",
- "type": "string"
- },
- "name": {
- "description": "Name of this metro region.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "response": {
+ "$ref": "FloodlightConfigurationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightConfigurations.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightConfiguration ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "MetrosListResponse": {
- "description": "Metro List Response",
- "id": "MetrosListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
- "type": "string"
- },
- "metros": {
- "description": "Metro collection.",
- "items": {
- "$ref": "Metro"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight configuration.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightConfigurations.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "inventoryItems": {
+ "methods": {
+ "get": {
+ "description": "Gets one inventory item by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Inventory item ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "MobileApp": {
- "description": "Contains information about a mobile app. Used as a landing page deep link.",
- "id": "MobileApp",
- "properties": {
- "directory": {
- "description": "Mobile app directory.",
- "enum": [
- "UNKNOWN",
- "APPLE_APP_STORE",
- "GOOGLE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this mobile app.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
- "type": "string"
- },
- "publisherName": {
- "description": "Publisher name.",
- "type": "string"
- },
- "title": {
- "description": "Title of this mobile app.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "MobileAppsListResponse": {
- "description": "Mobile app List Response",
- "id": "MobileAppsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
- "type": "string"
- },
- "mobileApps": {
- "description": "Mobile apps collection.",
- "items": {
- "$ref": "MobileApp"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "response": {
+ "$ref": "InventoryItem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only inventory items with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "MobileCarrier": {
- "description": "Contains information about a mobile carrier that can be targeted by ads.",
- "id": "MobileCarrier",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this mobile carrier belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this mobile carrier belongs.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this mobile carrier.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this mobile carrier.",
- "type": "string"
- }
+ "inPlan": {
+ "description": "Select only inventory items that are in plan.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "MobileCarriersListResponse": {
- "description": "Mobile Carrier List Response",
- "id": "MobileCarriersListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
- "type": "string"
- },
- "mobileCarriers": {
- "description": "Mobile carrier collection.",
- "items": {
- "$ref": "MobileCarrier"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "ObjectFilter": {
- "description": "Object Filter.",
- "id": "ObjectFilter",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
- "type": "string"
- },
- "objectIds": {
- "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "status": {
- "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
- "enum": [
- "NONE",
- "ASSIGNED",
- "ALL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "orderId": {
+ "description": "Select only inventory items that belong to specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "OffsetPosition": {
- "description": "Offset Position.",
- "id": "OffsetPosition",
- "properties": {
- "left": {
- "description": "Offset distance from left side of an asset or a window.",
- "format": "int32",
- "type": "integer"
- },
- "top": {
- "description": "Offset distance from top side of an asset or a window.",
- "format": "int32",
- "type": "integer"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OmnitureSettings": {
- "description": "Omniture Integration Settings.",
- "id": "OmnitureSettings",
- "properties": {
- "omnitureCostDataEnabled": {
- "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
- "type": "boolean"
- },
- "omnitureIntegrationEnabled": {
- "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystem": {
- "description": "Contains information about an operating system that can be targeted by ads.",
- "id": "OperatingSystem",
- "properties": {
- "dartId": {
- "description": "DART ID of this operating system. This is the ID used for targeting.",
- "format": "int64",
- "type": "string"
- },
- "desktop": {
- "description": "Whether this operating system is for desktop.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
- "type": "string"
- },
- "mobile": {
- "description": "Whether this operating system is for mobile.",
- "type": "boolean"
- },
- "name": {
- "description": "Name of this operating system.",
- "type": "string"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystemVersion": {
- "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
- "id": "OperatingSystemVersion",
- "properties": {
- "id": {
- "description": "ID of this operating system version.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
- "type": "string"
- },
- "majorVersion": {
- "description": "Major version (leftmost number) of this operating system version.",
- "type": "string"
- },
- "minorVersion": {
- "description": "Minor version (number after the first dot) of this operating system version.",
- "type": "string"
- },
- "name": {
- "description": "Name of this operating system version.",
- "type": "string"
- },
- "operatingSystem": {
- "$ref": "OperatingSystem",
- "description": "Operating system of this operating system version."
- }
+ "siteId": {
+ "description": "Select only inventory items that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystemVersionsListResponse": {
- "description": "Operating System Version List Response",
- "id": "OperatingSystemVersionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
- "type": "string"
- },
- "operatingSystemVersions": {
- "description": "Operating system version collection.",
- "items": {
- "$ref": "OperatingSystemVersion"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystemsListResponse": {
- "description": "Operating System List Response",
- "id": "OperatingSystemsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
- "type": "string"
- },
- "operatingSystems": {
- "description": "Operating system collection.",
- "items": {
- "$ref": "OperatingSystem"
- },
- "type": "array"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OptimizationActivity": {
- "description": "Creative optimization activity.",
- "id": "OptimizationActivity",
- "properties": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID of this optimization activity. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
- },
- "weight": {
- "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- }
+ "type": {
+ "description": "Select only inventory items with this type.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "response": {
+ "$ref": "InventoryItemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "languages": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of languages.",
+ "flatPath": "userprofiles/{profileId}/languages",
+ "httpMethod": "GET",
+ "id": "dfareporting.languages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/languages",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "metros": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of metros.",
+ "flatPath": "userprofiles/{profileId}/metros",
+ "httpMethod": "GET",
+ "id": "dfareporting.metros.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/metros",
+ "response": {
+ "$ref": "MetrosListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileApps": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile app by ID.",
+ "flatPath": "userprofiles/{profileId}/mobileApps/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile app ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Order": {
- "description": "Describes properties of a Planning order.",
- "id": "Order",
- "properties": {
- "accountId": {
- "description": "Account ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "approverUserProfileIds": {
- "description": "IDs for users that have to approve documents created for this order.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "buyerInvoiceId": {
- "description": "Buyer invoice ID associated with this order.",
- "type": "string"
- },
- "buyerOrganizationName": {
- "description": "Name of the buyer organization.",
- "type": "string"
- },
- "comments": {
- "description": "Comments in this order.",
- "type": "string"
- },
- "contacts": {
- "description": "Contacts for this order.",
- "items": {
- "$ref": "OrderContact"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this order. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this order."
- },
- "name": {
- "description": "Name of this order.",
- "type": "string"
- },
- "notes": {
- "description": "Notes of this order.",
- "type": "string"
- },
- "planningTermId": {
- "description": "ID of the terms and conditions template used in this order.",
- "format": "int64",
- "type": "string"
- },
- "projectId": {
- "description": "Project ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "sellerOrderId": {
- "description": "Seller order ID associated with this order.",
- "type": "string"
- },
- "sellerOrganizationName": {
- "description": "Name of the seller organization.",
- "type": "string"
- },
- "siteId": {
- "description": "Site IDs this order is associated with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "siteNames": {
- "description": "Free-form site names this order is associated with.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "subaccountId": {
- "description": "Subaccount ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "termsAndConditions": {
- "description": "Terms and conditions of this order.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileApps/{id}",
+ "response": {
+ "$ref": "MobileApp"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of available mobile apps.",
+ "flatPath": "userprofiles/{profileId}/mobileApps",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "directories": {
+ "description": "Select only apps from these directories.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "OrderContact": {
- "description": "Contact of an order.",
- "id": "OrderContact",
- "properties": {
- "contactInfo": {
- "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.",
- "type": "string"
- },
- "contactName": {
- "description": "Name of this contact.",
- "type": "string"
- },
- "contactTitle": {
- "description": "Title of this contact.",
- "type": "string"
- },
- "contactType": {
- "description": "Type of this contact.",
- "enum": [
- "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
- "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
- "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "signatureUserProfileId": {
- "description": "ID of the user profile containing the signature that will be embedded into order documents.",
- "format": "int64",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only apps with these IDs.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "OrderDocument": {
- "description": "Contains properties of a Planning order document.",
- "id": "OrderDocument",
- "properties": {
- "accountId": {
- "description": "Account ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "amendedOrderDocumentId": {
- "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
- "format": "int64",
- "type": "string"
- },
- "approvedByUserProfileIds": {
- "description": "IDs of users who have approved this order document.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "cancelled": {
- "description": "Whether this order document is cancelled.",
- "type": "boolean"
- },
- "createdInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this order document."
- },
- "effectiveDate": {
- "format": "date",
- "type": "string"
- },
- "id": {
- "description": "ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
- "type": "string"
- },
- "lastSentRecipients": {
- "description": "List of email addresses that received the last sent document.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "lastSentTime": {
- "format": "date-time",
- "type": "string"
- },
- "orderId": {
- "description": "ID of the order from which this order document is created.",
- "format": "int64",
- "type": "string"
- },
- "projectId": {
- "description": "Project ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "signed": {
- "description": "Whether this order document has been signed.",
- "type": "boolean"
- },
- "subaccountId": {
- "description": "Subaccount ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "title": {
- "description": "Title of this order document.",
- "type": "string"
- },
- "type": {
- "description": "Type of this order document",
- "enum": [
- "PLANNING_ORDER_TYPE_INSERTION_ORDER",
- "PLANNING_ORDER_TYPE_CHANGE_ORDER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "OrderDocumentsListResponse": {
- "description": "Order document List Response",
- "id": "OrderDocumentsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "orderDocuments": {
- "description": "Order document collection",
- "items": {
- "$ref": "OrderDocument"
- },
- "type": "array"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OrdersListResponse": {
- "description": "Order List Response",
- "id": "OrdersListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "orders": {
- "description": "Order collection.",
- "items": {
- "$ref": "Order"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PathToConversionReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "id": "PathToConversionReportCompatibleFields",
- "properties": {
- "conversionDimensions": {
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "customFloodlightVariables": {
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "perInteractionDimensions": {
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileApps",
+ "response": {
+ "$ref": "MobileAppsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileCarriers": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile carrier by ID.",
+ "flatPath": "userprofiles/{profileId}/mobileCarriers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile carrier ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Placement": {
- "description": "Contains properties of a placement.",
- "id": "Placement",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "adBlockingOptOut": {
- "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
- "type": "boolean"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this placement is archived.",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Campaign ID of this placement. This field is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "comment": {
- "description": "Comments for this placement.",
- "type": "string"
- },
- "compatibility": {
- "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "contentCategoryId": {
- "description": "ID of the content category assigned to this placement.",
- "format": "int64",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement. This is a read-only field."
- },
- "directorySiteId": {
- "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "description": "External ID for this placement.",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
- },
- "keyName": {
- "description": "Key name of this placement. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this placement."
- },
- "name": {
- "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.",
- "type": "string"
- },
- "paymentApproved": {
- "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
- "type": "boolean"
- },
- "paymentSource": {
- "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "placementGroupId": {
- "description": "ID of this placement's group, if applicable.",
- "format": "int64",
- "type": "string"
- },
- "placementGroupIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
- },
- "placementStrategyId": {
- "description": "ID of the placement strategy assigned to this placement.",
- "format": "int64",
- "type": "string"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
- },
- "primary": {
- "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
- "type": "boolean"
- },
- "publisherUpdateInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the last publisher update. This is a read-only field."
- },
- "siteId": {
- "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
- },
- "sslRequired": {
- "description": "Whether creatives assigned to this placement must be SSL-compliant.",
- "type": "boolean"
- },
- "status": {
- "description": "Third-party placement status.",
- "enum": [
- "PENDING_REVIEW",
- "PAYMENT_ACCEPTED",
- "PAYMENT_REJECTED",
- "ACKNOWLEDGE_REJECTION",
- "ACKNOWLEDGE_ACCEPTANCE",
- "DRAFT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagFormats": {
- "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
- "items": {
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Tag settings for this placement."
- },
- "videoActiveViewOptOut": {
- "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
- "type": "boolean"
- },
- "videoSettings": {
- "$ref": "VideoSettings",
- "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
- },
- "vpaidAdapterChoice": {
- "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
- "enum": [
- "DEFAULT",
- "FLASH",
- "HTML5",
- "BOTH"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileCarriers/{id}",
+ "response": {
+ "$ref": "MobileCarrier"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of mobile carriers.",
+ "flatPath": "userprofiles/{profileId}/mobileCarriers",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileCarriers",
+ "response": {
+ "$ref": "MobileCarriersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystemVersions": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system version by ID.",
+ "flatPath": "userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Operating system version ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementAssignment": {
- "description": "Placement Assignment.",
- "id": "PlacementAssignment",
- "properties": {
- "active": {
- "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
- "type": "boolean"
- },
- "placementId": {
- "description": "ID of the placement to be assigned. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "placementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
- },
- "sslRequired": {
- "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "response": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating system versions.",
+ "flatPath": "userprofiles/{profileId}/operatingSystemVersions",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystemVersions",
+ "response": {
+ "$ref": "OperatingSystemVersionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystems": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system by DART ID.",
+ "flatPath": "userprofiles/{profileId}/operatingSystems/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Operating system DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementGroup": {
- "description": "Contains properties of a package or roadblock.",
- "id": "PlacementGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this placement group. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this placement group is archived.",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Campaign ID of this placement group. This field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "childPlacementIds": {
- "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "comment": {
- "description": "Comments for this placement group.",
- "type": "string"
- },
- "contentCategoryId": {
- "description": "ID of the content category assigned to this placement group.",
- "format": "int64",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement group. This is a read-only field."
- },
- "directorySiteId": {
- "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "description": "External ID for this placement.",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement group. This is a read-only field."
- },
- "name": {
- "description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "placementGroupType": {
- "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "placementStrategyId": {
- "description": "ID of the placement strategy assigned to this placement group.",
- "format": "int64",
- "type": "string"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement group. This field is required on insertion."
- },
- "primaryPlacementId": {
- "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
- "format": "int64",
- "type": "string"
- },
- "primaryPlacementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
- },
- "siteId": {
- "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "subaccountId": {
- "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
+ "response": {
+ "$ref": "OperatingSystem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating systems.",
+ "flatPath": "userprofiles/{profileId}/operatingSystems",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystems",
+ "response": {
+ "$ref": "OperatingSystemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orderDocuments": {
+ "methods": {
+ "get": {
+ "description": "Gets one order document by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order document ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementGroupsListResponse": {
- "description": "Placement Group List Response",
- "id": "PlacementGroupsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placementGroups": {
- "description": "Placement group collection.",
- "items": {
- "$ref": "PlacementGroup"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementStrategiesListResponse": {
- "description": "Placement Strategy List Response",
- "id": "PlacementStrategiesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placementStrategies": {
- "description": "Placement strategy collection.",
- "items": {
- "$ref": "PlacementStrategy"
- },
- "type": "array"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "response": {
+ "$ref": "OrderDocument"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "approved": {
+ "description": "Select only order documents that have been approved by at least one user.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "PlacementStrategy": {
- "description": "Contains properties of a placement strategy.",
- "id": "PlacementStrategy",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only order documents with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementTag": {
- "description": "Placement Tag",
- "id": "PlacementTag",
- "properties": {
- "placementId": {
- "description": "Placement ID",
- "format": "int64",
- "type": "string"
- },
- "tagDatas": {
- "description": "Tags generated for this placement.",
- "items": {
- "$ref": "TagData"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "PlacementsGenerateTagsResponse": {
- "description": "Placement GenerateTags Response",
- "id": "PlacementsGenerateTagsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
- "type": "string"
- },
- "placementTags": {
- "description": "Set of generated tags for the specified placements.",
- "items": {
- "$ref": "PlacementTag"
- },
- "type": "array"
- }
+ "orderId": {
+ "description": "Select only order documents for specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementsListResponse": {
- "description": "Placement List Response",
- "id": "PlacementsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placements": {
- "description": "Placement collection.",
- "items": {
- "$ref": "Placement"
- },
- "type": "array"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PlatformType": {
- "description": "Contains information about a platform type that can be targeted by ads.",
- "id": "PlatformType",
- "properties": {
- "id": {
- "description": "ID of this platform type.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this platform type.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlatformTypesListResponse": {
- "description": "Platform Type List Response",
- "id": "PlatformTypesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
- "type": "string"
- },
- "platformTypes": {
- "description": "Platform type collection.",
- "items": {
- "$ref": "PlatformType"
- },
- "type": "array"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PopupWindowProperties": {
- "description": "Popup Window Properties.",
- "id": "PopupWindowProperties",
- "properties": {
- "dimension": {
- "$ref": "Size",
- "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
- },
- "positionType": {
- "description": "Popup window position either centered or at specific coordinate.",
- "enum": [
- "CENTER",
- "COORDINATES"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "showAddressBar": {
- "description": "Whether to display the browser address bar.",
- "type": "boolean"
- },
- "showMenuBar": {
- "description": "Whether to display the browser menu bar.",
- "type": "boolean"
- },
- "showScrollBar": {
- "description": "Whether to display the browser scroll bar.",
- "type": "boolean"
- },
- "showStatusBar": {
- "description": "Whether to display the browser status bar.",
- "type": "boolean"
- },
- "showToolBar": {
- "description": "Whether to display the browser tool bar.",
- "type": "boolean"
- },
- "title": {
- "description": "Title of popup window.",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PostalCode": {
- "description": "Contains information about a postal code that can be targeted by ads.",
- "id": "PostalCode",
- "properties": {
- "code": {
- "description": "Postal code. This is equivalent to the id field.",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the country to which this postal code belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this postal code belongs.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this postal code.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
- "type": "string"
- }
+ "siteId": {
+ "description": "Select only order documents that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PostalCodesListResponse": {
- "description": "Postal Code List Response",
- "id": "PostalCodesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
- "type": "string"
- },
- "postalCodes": {
- "description": "Postal code collection.",
- "items": {
- "$ref": "PostalCode"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Pricing": {
- "description": "Pricing Information",
- "id": "Pricing",
- "properties": {
- "capCostType": {
- "description": "Cap cost type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "flights": {
- "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
- "items": {
- "$ref": "Flight"
- },
- "type": "array"
- },
- "groupType": {
- "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
- "enum": [
- "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
- "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "pricingType": {
- "description": "Pricing type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
- "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "response": {
+ "$ref": "OrderDocumentsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orders": {
+ "methods": {
+ "get": {
+ "description": "Gets one order by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PricingSchedule": {
- "description": "Pricing Schedule",
- "id": "PricingSchedule",
- "properties": {
- "capCostOption": {
- "description": "Placement cap cost option.",
- "enum": [
- "CAP_COST_NONE",
- "CAP_COST_MONTHLY",
- "CAP_COST_CUMULATIVE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "disregardOverdelivery": {
- "description": "Whether cap costs are ignored by ad serving.",
- "type": "boolean"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "flighted": {
- "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.",
- "type": "boolean"
- },
- "floodlightActivityId": {
- "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
- "format": "int64",
- "type": "string"
- },
- "pricingPeriods": {
- "description": "Pricing periods for this placement.",
- "items": {
- "$ref": "PricingSchedulePricingPeriod"
- },
- "type": "array"
- },
- "pricingType": {
- "description": "Placement pricing type. This field is required on insertion.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "testingStartDate": {
- "format": "date",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "response": {
+ "$ref": "Order"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only orders with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Select only orders that are associated with these site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders",
+ "response": {
+ "$ref": "OrdersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one placement group by ID.",
+ "flatPath": "userprofiles/{profileId}/placementGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups/{id}",
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement group.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placement groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only placement groups that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placement groups that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placement groups that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placement groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "800",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "800",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placement groups that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placement groups with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placement groups that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "response": {
+ "$ref": "PlacementGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement group.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementStrategies": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.placementStrategies.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement strategy by ID.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies/{id}",
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementStrategies.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only placement strategies with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "response": {
+ "$ref": "PlacementStrategiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement strategy. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementStrategies.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementStrategy ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementStrategies.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placements": {
+ "methods": {
+ "generatetags": {
+ "description": "Generates tags for a placement.",
+ "flatPath": "userprofiles/{profileId}/placements/generatetags",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.generatetags",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Generate placements belonging to this campaign. This is a required field.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Generate tags for these placements.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements/generatetags",
+ "response": {
+ "$ref": "PlacementsGenerateTagsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement by ID.",
+ "flatPath": "userprofiles/{profileId}/placements/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements/{id}",
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placements that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only placements that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibilities": {
+ "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placements that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placements that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "groupIds": {
+ "description": "Select only placements that belong to these placement groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placements with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "paymentSource": {
+ "description": "Select only placements with this payment source.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placements that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placements with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placements that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only placements that are associated with these sizes.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "response": {
+ "$ref": "PlacementsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placements.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placements.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "platformTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one platform type by ID.",
+ "flatPath": "userprofiles/{profileId}/platformTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Platform type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/platformTypes/{id}",
+ "response": {
+ "$ref": "PlatformType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of platform types.",
+ "flatPath": "userprofiles/{profileId}/platformTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/platformTypes",
+ "response": {
+ "$ref": "PlatformTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "postalCodes": {
+ "methods": {
+ "get": {
+ "description": "Gets one postal code by ID.",
+ "flatPath": "userprofiles/{profileId}/postalCodes/{code}",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.get",
+ "parameterOrder": [
+ "profileId",
+ "code"
+ ],
+ "parameters": {
+ "code": {
+ "description": "Postal code ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/postalCodes/{code}",
+ "response": {
+ "$ref": "PostalCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of postal codes.",
+ "flatPath": "userprofiles/{profileId}/postalCodes",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/postalCodes",
+ "response": {
+ "$ref": "PostalCodesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "get": {
+ "description": "Gets one project by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Project ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{id}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
+ "flatPath": "userprofiles/{profileId}/projects",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only projects with these advertiser IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only projects with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects",
+ "response": {
+ "$ref": "ProjectsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "regions": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of regions.",
+ "flatPath": "userprofiles/{profileId}/regions",
+ "httpMethod": "GET",
+ "id": "dfareporting.regions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/regions",
+ "response": {
+ "$ref": "RegionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingListShares": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list share by remarketing list ID.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingListShares.get",
+ "parameterOrder": [
+ "profileId",
+ "remarketingListId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list share. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingListShares.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list share.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingListShares.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists/{id}",
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new remarketing list.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "POST",
+ "id": "dfareporting.remarketingLists.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only remarketing lists owned by this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "floodlightActivityId": {
+ "description": "Select only remarketing lists that have this floodlight activity ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "response": {
+ "$ref": "RemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingLists.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingLists.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a report by its ID.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.reports.delete",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a report by its ID.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "insert": {
+ "description": "Creates a report.",
+ "flatPath": "userprofiles/{profileId}/reports",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of reports.",
+ "flatPath": "userprofiles/{profileId}/reports",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE"
+ ],
+ "enumDescriptions": [
+ "All reports in account.",
+ "My reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "Sort by report ID.",
+ "Sort by 'lastModifiedTime' field.",
+ "Sort by name of reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports",
+ "response": {
+ "$ref": "ReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing report. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.reports.patch",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The DFA user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "run": {
+ "description": "Runs a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/run",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.run",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "synchronous": {
+ "default": "false",
+ "description": "If set and true, tries to run the report synchronously.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/run",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "update": {
+ "description": "Updates a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PUT",
+ "id": "dfareporting.reports.update",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ },
+ "resources": {
+ "compatibleFields": {
+ "methods": {
+ "query": {
+ "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
+ "flatPath": "userprofiles/{profileId}/reports/compatiblefields/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.compatibleFields.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/compatiblefields/query",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "CompatibleFields"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
+ },
+ "list": {
+ "description": "Lists files for a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.list",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the parent report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets one site by ID.",
+ "flatPath": "userprofiles/{profileId}/sites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites/{id}",
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new site.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "POST",
+ "id": "dfareporting.sites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only sites that accept publisher paid placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "adWordsSite": {
+ "description": "Select only AdWords sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "approved": {
+ "description": "Select only approved sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only sites with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only sites with these directory site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only sites with this subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "unmappedSite": {
+ "description": "Select only sites that have not been mapped to a directory site.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "response": {
+ "$ref": "SitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing site. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.sites.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing site.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "PUT",
+ "id": "dfareporting.sites.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "sizes": {
+ "methods": {
+ "get": {
+ "description": "Gets one size by ID.",
+ "flatPath": "userprofiles/{profileId}/sizes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Size ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes/{id}",
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new size.",
+ "flatPath": "userprofiles/{profileId}/sizes",
+ "httpMethod": "POST",
+ "id": "dfareporting.sizes.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes",
+ "request": {
+ "$ref": "Size"
+ },
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
+ "flatPath": "userprofiles/{profileId}/sizes",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "height": {
+ "description": "Select only sizes with this height.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "iabStandard": {
+ "description": "Select only IAB standard sizes.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only sizes with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "width": {
+ "description": "Select only sizes with this width.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes",
+ "response": {
+ "$ref": "SizesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "subaccounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one subaccount by ID.",
+ "flatPath": "userprofiles/{profileId}/subaccounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts/{id}",
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new subaccount.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "POST",
+ "id": "dfareporting.subaccounts.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only subaccounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "response": {
+ "$ref": "SubaccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing subaccount. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.subaccounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing subaccount.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.subaccounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetableRemarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "response": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/targetableRemarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive targetable remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only targetable remarketing lists targetable by these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetableRemarketingLists",
+ "response": {
+ "$ref": "TargetableRemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetingTemplates": {
+ "methods": {
+ "get": {
+ "description": "Gets one targeting template by ID.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Targeting template ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates/{id}",
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new targeting template.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "POST",
+ "id": "dfareporting.targetingTemplates.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only targeting templates with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only targeting templates with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "response": {
+ "$ref": "TargetingTemplatesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing targeting template. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.targetingTemplates.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "TargetingTemplate ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing targeting template.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PUT",
+ "id": "dfareporting.targetingTemplates.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one user profile by ID.",
+ "flatPath": "userprofiles/{profileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.get",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of user profiles for a user.",
+ "flatPath": "userprofiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.list",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "userprofiles",
+ "response": {
+ "$ref": "UserProfileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission group by ID.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "response": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of all supported user role permission groups.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissionGroups",
+ "response": {
+ "$ref": "UserRolePermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission by ID.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissions/{id}",
+ "response": {
+ "$ref": "UserRolePermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of user role permissions, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only user role permissions with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissions",
+ "response": {
+ "$ref": "UserRolePermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRoles": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.userRoles.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one user role by ID.",
+ "flatPath": "userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles/{id}",
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "POST",
+ "id": "dfareporting.userRoles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "accountUserRoleOnly": {
+ "description": "Select only account level user roles not associated with any specific subaccount.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user roles with the specified IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user roles that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "response": {
+ "$ref": "UserRolesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing user role. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.userRoles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "UserRole ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.userRoles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "videoFormats": {
+ "methods": {
+ "get": {
+ "description": "Gets one video format by ID.",
+ "flatPath": "userprofiles/{profileId}/videoFormats/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Video format ID.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/videoFormats/{id}",
+ "response": {
+ "$ref": "VideoFormat"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Lists available video formats.",
+ "flatPath": "userprofiles/{profileId}/videoFormats",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/videoFormats",
+ "response": {
+ "$ref": "VideoFormatsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210524",
+ "rootUrl": "https://dfareporting.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Contains properties of a Campaign Manager account.",
+ "id": "Account",
+ "properties": {
+ "accountPermissionIds": {
+ "description": "Account permissions assigned to this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "accountProfile": {
+ "description": "Profile for this account. This is a read-only field that can be left blank.",
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this account is active.",
+ "type": "boolean"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for this account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "activeViewOptOut": {
+ "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.",
+ "type": "boolean"
+ },
+ "availablePermissionIds": {
+ "description": "User role permissions available to the user roles of this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "countryId": {
+ "description": "ID of the country associated with this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyId": {
+ "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultCreativeSizeId": {
+ "description": "Default placement dimensions for this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of this account.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this account. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "maximumImageSize": {
+ "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.",
+ "type": "boolean"
+ },
+ "reportsConfiguration": {
+ "$ref": "ReportsConfiguration",
+ "description": "Reporting configuration of this account."
+ },
+ "shareReportsWithTwitter": {
+ "description": "Share Path to Conversion reports with Twitter.",
+ "type": "boolean"
+ },
+ "teaserSizeLimit": {
+ "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountActiveAdSummary": {
+ "description": "Gets a summary of active ads in an account.",
+ "id": "AccountActiveAdSummary",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAds": {
+ "description": "Ads that have been activated for the account",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for the account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "availableAds": {
+ "description": "Ads that can be activated for the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermission": {
+ "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
+ "id": "AccountPermission",
+ "properties": {
+ "accountProfiles": {
+ "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
+ "items": {
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this account permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
+ "type": "string"
+ },
+ "level": {
+ "description": "Administrative level required to enable this account permission.",
+ "enum": [
+ "USER",
+ "ADMINISTRATOR"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "Permission group of this account permission.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroup": {
+ "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
+ "id": "AccountPermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this account permission group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroupsListResponse": {
+ "description": "Account Permission Group List Response",
+ "id": "AccountPermissionGroupsListResponse",
+ "properties": {
+ "accountPermissionGroups": {
+ "description": "Account permission group collection.",
+ "items": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionsListResponse": {
+ "description": "Account Permission List Response",
+ "id": "AccountPermissionsListResponse",
+ "properties": {
+ "accountPermissions": {
+ "description": "Account permission collection.",
+ "items": {
+ "$ref": "AccountPermission"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfile": {
+ "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
+ "id": "AccountUserProfile",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.",
+ "type": "boolean"
+ },
+ "advertiserFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which advertisers are visible to the user profile."
+ },
+ "campaignFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which campaigns are visible to the user profile."
+ },
+ "comments": {
+ "description": "Comments for this user profile.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the user profile. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".",
+ "type": "string"
+ },
+ "siteFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which sites are visible to the user profile."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerType": {
+ "description": "Trafficker type of this user profile. This is a read-only field.",
+ "enum": [
+ "INTERNAL_NON_TRAFFICKER",
+ "INTERNAL_TRAFFICKER",
+ "EXTERNAL_TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userAccessType": {
+ "description": "User type of the user profile. This is a read-only field that can be left blank.",
+ "enum": [
+ "NORMAL_USER",
+ "SUPER_USER",
+ "INTERNAL_ADMINISTRATOR",
+ "READ_ONLY_SUPER_USER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userRoleFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which user roles are visible to the user profile."
+ },
+ "userRoleId": {
+ "description": "User role ID of the user profile. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfilesListResponse": {
+ "description": "Account User Profile List Response",
+ "id": "AccountUserProfilesListResponse",
+ "properties": {
+ "accountUserProfiles": {
+ "description": "Account user profile collection.",
+ "items": {
+ "$ref": "AccountUserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsListResponse": {
+ "description": "Account List Response",
+ "id": "AccountsListResponse",
+ "properties": {
+ "accounts": {
+ "description": "Account collection.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Activities": {
+ "description": "Represents an activity group.",
+ "id": "Activities",
+ "properties": {
+ "filters": {
+ "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#activities.",
+ "type": "string"
+ },
+ "metricNames": {
+ "description": "List of names of floodlight activity metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Ad": {
+ "description": "Contains properties of a Campaign Manager ad.",
+ "id": "Ad",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this ad is active. When true, archived must be false.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this ad is archived. When true, active must be false.",
+ "type": "boolean"
+ },
+ "audienceSegmentId": {
+ "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
+ },
+ "comments": {
+ "description": "Comments for this ad.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this ad. This is a read-only field."
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeRotation": {
+ "$ref": "CreativeRotation",
+ "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Default click-through event tag properties for this ad."
+ },
+ "deliverySchedule": {
+ "$ref": "DeliverySchedule",
+ "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
+ },
+ "dynamicClickTracker": {
+ "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Event tag overrides for this ad.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "id": {
+ "description": "ID of this ad. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this ad. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this ad. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementAssignments": {
+ "description": "Placement assignments for this ad.",
+ "items": {
+ "$ref": "PlacementAssignment"
+ },
+ "type": "array"
+ },
+ "remarketingListExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
+ },
+ "sslCompliant": {
+ "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "type": {
+ "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdBlockingConfiguration": {
+ "description": "Campaign ad blocking settings.",
+ "id": "AdBlockingConfiguration",
+ "properties": {
+ "clickThroughUrl": {
+ "description": "Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.",
+ "type": "string"
+ },
+ "creativeBundleId": {
+ "description": "ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.",
+ "format": "int64",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.",
+ "type": "boolean"
+ },
+ "overrideClickThroughUrl": {
+ "description": "Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdSlot": {
+ "description": "Ad Slot",
+ "id": "AdSlot",
+ "properties": {
+ "comment": {
+ "description": "Comment for this ad slot.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "height": {
+ "description": "Height of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "linkedPlacementId": {
+ "description": "ID of the placement from an external platform that is linked to this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this ad slot.",
+ "type": "string"
+ },
+ "paymentSourceType": {
+ "description": "Payment source type of this ad slot.",
+ "enum": [
+ "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
+ "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "primary": {
+ "description": "Primary ad slot of a roadblock inventory item.",
+ "type": "boolean"
+ },
+ "width": {
+ "description": "Width of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdsListResponse": {
+ "description": "Ad List Response",
+ "id": "AdsListResponse",
+ "properties": {
+ "ads": {
+ "description": "Ad collection.",
+ "items": {
+ "$ref": "Ad"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Advertiser": {
+ "description": "Contains properties of a Campaign Manager advertiser.",
+ "id": "Advertiser",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserGroupId": {
+ "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickThroughUrlSuffix": {
+ "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
+ "type": "string"
+ },
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultEmail": {
+ "description": "Default email address used in sender field for tag emails.",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this advertiser. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
+ "type": "string"
+ },
+ "originalFloodlightConfigurationId": {
+ "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this advertiser.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "suspended": {
+ "description": "Suspension status of this advertiser.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroup": {
+ "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
+ "id": "AdvertiserGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroupsListResponse": {
+ "description": "Advertiser Group List Response",
+ "id": "AdvertiserGroupsListResponse",
+ "properties": {
+ "advertiserGroups": {
+ "description": "Advertiser group collection.",
+ "items": {
+ "$ref": "AdvertiserGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserLandingPagesListResponse": {
+ "description": "Landing Page List Response",
+ "id": "AdvertiserLandingPagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
+ "type": "string"
+ },
+ "landingPages": {
+ "description": "Landing page collection",
+ "items": {
+ "$ref": "LandingPage"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertisersListResponse": {
+ "description": "Advertiser List Response",
+ "id": "AdvertisersListResponse",
+ "properties": {
+ "advertisers": {
+ "description": "Advertiser collection.",
+ "items": {
+ "$ref": "Advertiser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegment": {
+ "description": "Audience Segment.",
+ "id": "AudienceSegment",
+ "properties": {
+ "allocation": {
+ "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this audience segment. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegmentGroup": {
+ "description": "Audience Segment Group.",
+ "id": "AudienceSegmentGroup",
+ "properties": {
+ "audienceSegments": {
+ "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
+ "items": {
+ "$ref": "AudienceSegment"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Browser": {
+ "description": "Contains information about a browser that can be targeted by ads.",
+ "id": "Browser",
+ "properties": {
+ "browserVersionId": {
+ "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this browser. This is the ID used when generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BrowsersListResponse": {
+ "description": "Browser List Response",
+ "id": "BrowsersListResponse",
+ "properties": {
+ "browsers": {
+ "description": "Browser collection.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Campaign": {
+ "description": "Contains properties of a Campaign Manager campaign.",
+ "id": "Campaign",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingConfiguration": {
+ "$ref": "AdBlockingConfiguration",
+ "description": "Ad blocking settings for this campaign."
+ },
+ "additionalCreativeOptimizationConfigurations": {
+ "description": "Additional creative optimization configurations for the campaign.",
+ "items": {
+ "$ref": "CreativeOptimizationConfiguration"
+ },
+ "type": "array"
+ },
+ "advertiserGroupId": {
+ "description": "Advertiser group ID of the associated advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this campaign has been archived.",
+ "type": "boolean"
+ },
+ "audienceSegmentGroups": {
+ "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
+ "items": {
+ "$ref": "AudienceSegmentGroup"
+ },
+ "type": "array"
+ },
+ "billingInvoiceCode": {
+ "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.",
+ "type": "string"
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix override properties for this campaign."
+ },
+ "comment": {
+ "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this campaign. This is a read-only field."
+ },
+ "creativeGroupIds": {
+ "description": "List of creative group IDs that are assigned to the campaign.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfiguration": {
+ "$ref": "CreativeOptimizationConfiguration",
+ "description": "Creative optimization configuration for the campaign."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Click-through event tag ID override properties for this campaign."
+ },
+ "defaultLandingPageId": {
+ "description": "The default landing page ID for this campaign.",
+ "format": "int64",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "externalId": {
+ "description": "External ID for this campaign.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this campaign. This is a read-only auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this campaign. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether Nielsen reports are enabled for this campaign.",
+ "type": "boolean"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerEmails": {
+ "description": "Campaign trafficker contact emails.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociation": {
+ "description": "Identifies a creative which has been associated with a given campaign.",
+ "id": "CampaignCreativeAssociation",
+ "properties": {
+ "creativeId": {
+ "description": "ID of the creative associated with the campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociationsListResponse": {
+ "description": "Campaign Creative Association List Response",
+ "id": "CampaignCreativeAssociationsListResponse",
+ "properties": {
+ "campaignCreativeAssociations": {
+ "description": "Campaign creative association collection",
+ "items": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignsListResponse": {
+ "description": "Campaign List Response",
+ "id": "CampaignsListResponse",
+ "properties": {
+ "campaigns": {
+ "description": "Campaign collection.",
+ "items": {
+ "$ref": "Campaign"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLog": {
+ "description": "Describes a change that a user has made to a resource.",
+ "id": "ChangeLog",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "action": {
+ "description": "Action which caused the change.",
+ "type": "string"
+ },
+ "changeTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "fieldName": {
+ "description": "Field name of the object which changed.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this change log.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
+ "type": "string"
+ },
+ "newValue": {
+ "description": "New value of the object field.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Object type of the change log.",
+ "type": "string"
+ },
+ "oldValue": {
+ "description": "Old value of the object field.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transactionId": {
+ "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileId": {
+ "description": "ID of the user who modified the object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileName": {
+ "description": "User profile name of the user who modified the object.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLogsListResponse": {
+ "description": "Change Log List Response",
+ "id": "ChangeLogsListResponse",
+ "properties": {
+ "changeLogs": {
+ "description": "Change log collection.",
+ "items": {
+ "$ref": "ChangeLog"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CitiesListResponse": {
+ "description": "City List Response",
+ "id": "CitiesListResponse",
+ "properties": {
+ "cities": {
+ "description": "City collection.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "City": {
+ "description": "Contains information about a city that can be targeted by ads.",
+ "id": "City",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this city belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro region code of the metro region (DMA) to which this city belongs.",
+ "type": "string"
+ },
+ "metroDmaId": {
+ "description": "ID of the metro region (DMA) to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this city.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code of the region to which this city belongs.",
+ "type": "string"
+ },
+ "regionDartId": {
+ "description": "DART ID of the region to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickTag": {
+ "description": "Creative Click Tag.",
+ "id": "ClickTag",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Parameter value for the specified click tag. This field contains a click-through url."
+ },
+ "eventName": {
+ "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "ClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "defaultLandingPage": {
+ "description": "Whether the campaign default landing page is used.",
+ "type": "boolean"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrlSuffixProperties": {
+ "description": "Click Through URL Suffix settings.",
+ "id": "ClickThroughUrlSuffixProperties",
+ "properties": {
+ "clickThroughUrlSuffix": {
+ "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
+ "type": "string"
+ },
+ "overrideInheritedSuffix": {
+ "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionClickThroughOverride": {
+ "description": "Companion Click-through override.",
+ "id": "CompanionClickThroughOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this companion click-through override."
+ },
+ "creativeId": {
+ "description": "ID of the creative for this companion click-through override.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionSetting": {
+ "description": "Companion Settings",
+ "id": "CompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this placement.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompatibleFields": {
+ "description": "Represents a response to the queryCompatibleFields method.",
+ "id": "CompatibleFields",
+ "properties": {
+ "crossDimensionReachReportCompatibleFields": {
+ "$ref": "CrossDimensionReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
+ },
+ "floodlightReportCompatibleFields": {
+ "$ref": "FloodlightReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
+ "type": "string"
+ },
+ "pathToConversionReportCompatibleFields": {
+ "$ref": "PathToConversionReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
+ },
+ "reachReportCompatibleFields": {
+ "$ref": "ReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
+ },
+ "reportCompatibleFields": {
+ "$ref": "ReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionType": {
+ "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
+ "id": "ConnectionType",
+ "properties": {
+ "id": {
+ "description": "ID of this connection type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this connection type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionTypesListResponse": {
+ "description": "Connection Type List Response",
+ "id": "ConnectionTypesListResponse",
+ "properties": {
+ "connectionTypes": {
+ "description": "Collection of connection types such as broadband and mobile.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategoriesListResponse": {
+ "description": "Content Category List Response",
+ "id": "ContentCategoriesListResponse",
+ "properties": {
+ "contentCategories": {
+ "description": "Content category collection.",
+ "items": {
+ "$ref": "ContentCategory"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategory": {
+ "description": "Organizes placements according to the contents of their associated webpages.",
+ "id": "ContentCategory",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this content category. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this content category. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Conversion": {
+ "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
+ "id": "Conversion",
+ "properties": {
+ "childDirectedTreatment": {
+ "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
+ "type": "boolean"
+ },
+ "customVariables": {
+ "description": "Custom floodlight variables.",
+ "items": {
+ "$ref": "CustomFloodlightVariable"
+ },
+ "type": "array"
+ },
+ "encryptedUserId": {
+ "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
+ "type": "string"
+ },
+ "encryptedUserIdCandidates": {
+ "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight Activity ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight Configuration ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "gclid": {
+ "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is a required field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
+ "type": "string"
+ },
+ "limitAdTracking": {
+ "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
+ "type": "boolean"
+ },
+ "matchId": {
+ "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.",
+ "type": "string"
+ },
+ "mobileDeviceId": {
+ "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid is a required field.",
+ "type": "string"
+ },
+ "nonPersonalizedAd": {
+ "description": "Whether the conversion was for a non personalized ad.",
+ "type": "boolean"
+ },
+ "ordinal": {
+ "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity of the conversion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timestampMicros": {
+ "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "treatmentForUnderage": {
+ "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The value of the conversion.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionError": {
+ "description": "The error code and description for a conversion that failed to insert or update.",
+ "id": "ConversionError",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "INVALID_ARGUMENT",
+ "INTERNAL",
+ "PERMISSION_DENIED",
+ "NOT_FOUND"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
+ "type": "string"
+ },
+ "message": {
+ "description": "A description of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionStatus": {
+ "description": "The original conversion that was inserted or updated and whether there were any errors.",
+ "id": "ConversionStatus",
+ "properties": {
+ "conversion": {
+ "$ref": "Conversion",
+ "description": "The original conversion that was inserted or updated."
+ },
+ "errors": {
+ "description": "A list of errors related to this conversion.",
+ "items": {
+ "$ref": "ConversionError"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertRequest": {
+ "description": "Insert Conversions Request.",
+ "id": "ConversionsBatchInsertRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to insert.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertResponse": {
+ "description": "Insert Conversions Response.",
+ "id": "ConversionsBatchInsertResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to insert.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateRequest": {
+ "description": "Update Conversions Request.",
+ "id": "ConversionsBatchUpdateRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to update.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateResponse": {
+ "description": "Update Conversions Response.",
+ "id": "ConversionsBatchUpdateResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to update.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CountriesListResponse": {
+ "description": "Country List Response",
+ "id": "CountriesListResponse",
+ "properties": {
+ "countries": {
+ "description": "Country collection.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Country": {
+ "description": "Contains information about a country that can be targeted by ads.",
+ "id": "Country",
+ "properties": {
+ "countryCode": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this country.",
+ "type": "string"
+ },
+ "sslEnabled": {
+ "description": "Whether ad serving supports secure servers in this country.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Creative": {
+ "description": "Contains properties of a Creative.",
+ "id": "Creative",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether the creative is active. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "adParameters": {
+ "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "type": "string"
+ },
+ "adTagKeys": {
+ "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "allowScriptAccess": {
+ "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "boolean"
+ },
+ "archived": {
+ "description": "Whether the creative is archived. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "artworkType": {
+ "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringSource": {
+ "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
+ "enum": [
+ "CREATIVE_AUTHORING_SOURCE_DCM",
+ "CREATIVE_AUTHORING_SOURCE_DBM",
+ "CREATIVE_AUTHORING_SOURCE_STUDIO",
+ "CREATIVE_AUTHORING_SOURCE_GWD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringTool": {
+ "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "enum": [
+ "NINJA",
+ "SWIFFY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "autoAdvanceImages": {
+ "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
+ "type": "boolean"
+ },
+ "backgroundColor": {
+ "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "string"
+ },
+ "backupImageClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE."
+ },
+ "backupImageFeatures": {
+ "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "backupImageReportingLabel": {
+ "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "backupImageTargetWindow": {
+ "$ref": "TargetWindow",
+ "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "clickTags": {
+ "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "commercialId": {
+ "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.",
+ "type": "string"
+ },
+ "companionCreatives": {
+ "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibility": {
+ "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "convertFlashToHtml5": {
+ "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "counterCustomEvents": {
+ "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "creativeAssetSelection": {
+ "$ref": "CreativeAssetSelection",
+ "description": "Required if dynamicAssetSelection is true."
+ },
+ "creativeAssets": {
+ "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
+ "items": {
+ "$ref": "CreativeAsset"
+ },
+ "type": "array"
+ },
+ "creativeFieldAssignments": {
+ "description": "Creative field assignments for this creative. Applicable to all creative types.",
+ "items": {
+ "$ref": "CreativeFieldAssignment"
+ },
+ "type": "array"
+ },
+ "customKeyValues": {
+ "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dynamicAssetSelection": {
+ "description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.",
+ "type": "boolean"
+ },
+ "exitCustomEvents": {
+ "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "fsCommand": {
+ "$ref": "FsCommand",
+ "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
+ },
+ "htmlCode": {
+ "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
+ "type": "string"
+ },
+ "htmlCodeLocked": {
+ "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
+ },
+ "latestTraffickedCreativeId": {
+ "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "mediaDescription": {
+ "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
+ "type": "string"
+ },
+ "mediaDuration": {
+ "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "name": {
+ "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.",
+ "type": "string"
+ },
+ "overrideCss": {
+ "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "redirectUrl": {
+ "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT",
+ "type": "string"
+ },
+ "renderingId": {
+ "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "renderingIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "requiredFlashPluginVersion": {
+ "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "type": "string"
+ },
+ "requiredFlashVersion": {
+ "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "skippable": {
+ "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "sslOverride": {
+ "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "studioAdvertiserId": {
+ "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioCreativeId": {
+ "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioTraffickedCreativeId": {
+ "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "thirdPartyBackupImageImpressionsUrl": {
+ "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyRichMediaImpressionsUrl": {
+ "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyUrls": {
+ "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
+ "items": {
+ "$ref": "ThirdPartyTrackingUrl"
+ },
+ "type": "array"
+ },
+ "timerCustomEvents": {
+ "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "totalFileSize": {
+ "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "universalAdId": {
+ "$ref": "UniversalAdId",
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
+ },
+ "version": {
+ "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAsset": {
+ "description": "Creative Asset.",
+ "id": "CreativeAsset",
+ "properties": {
+ "actionScript3": {
+ "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "active": {
+ "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "alignment": {
+ "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .",
+ "enum": [
+ "ALIGNMENT_TOP",
+ "ALIGNMENT_RIGHT",
+ "ALIGNMENT_BOTTOM",
+ "ALIGNMENT_LEFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
+ },
+ "audioBitRate": {
+ "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "audioSampleRate": {
+ "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "backupImageExit": {
+ "$ref": "CreativeCustomEvent",
+ "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "bitRate": {
+ "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "childAssetType": {
+ "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "enum": [
+ "CHILD_ASSET_TYPE_FLASH",
+ "CHILD_ASSET_TYPE_VIDEO",
+ "CHILD_ASSET_TYPE_IMAGE",
+ "CHILD_ASSET_TYPE_DATA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "collapsedSize": {
+ "$ref": "Size",
+ "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "companionCreativeIds": {
+ "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "customStartTimeValue": {
+ "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "displayType": {
+ "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DISPLAY_TYPE_INPAGE",
+ "ASSET_DISPLAY_TYPE_FLOATING",
+ "ASSET_DISPLAY_TYPE_OVERLAY",
+ "ASSET_DISPLAY_TYPE_EXPANDING",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
+ "ASSET_DISPLAY_TYPE_PEEL_DOWN",
+ "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
+ "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
+ "ASSET_DISPLAY_TYPE_BACKDROP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "duration": {
+ "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "durationType": {
+ "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DURATION_TYPE_AUTO",
+ "ASSET_DURATION_TYPE_NONE",
+ "ASSET_DURATION_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "expandedDimension": {
+ "$ref": "Size",
+ "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
+ },
+ "fileSize": {
+ "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "flashVersion": {
+ "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frameRate": {
+ "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "hideFlashObjects": {
+ "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "hideSelectionBoxes": {
+ "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "horizontallyLocked": {
+ "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
+ },
+ "mediaDuration": {
+ "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "mimeType": {
+ "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "orientation": {
+ "description": "Orientation of video asset. This is a read-only, auto-generated field.",
+ "enum": [
+ "LANDSCAPE",
+ "PORTRAIT",
+ "SQUARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "originalBackup": {
+ "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "politeLoad": {
+ "description": "Whether this asset is used as a polite load asset.",
+ "type": "boolean"
+ },
+ "position": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "positionLeftUnit": {
+ "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "positionTopUnit": {
+ "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "progressiveServingUrl": {
+ "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "pushdown": {
+ "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
+ "type": "boolean"
+ },
+ "pushdownDuration": {
+ "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
+ "format": "float",
+ "type": "number"
+ },
+ "role": {
+ "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
+ "enum": [
+ "PRIMARY",
+ "BACKUP_IMAGE",
+ "ADDITIONAL_IMAGE",
+ "ADDITIONAL_FLASH",
+ "PARENT_VIDEO",
+ "TRANSCODED_VIDEO",
+ "OTHER",
+ "ALTERNATE_VIDEO",
+ "PARENT_AUDIO",
+ "TRANSCODED_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "sslCompliant": {
+ "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "type": "boolean"
+ },
+ "startTimeType": {
+ "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_START_TIME_TYPE_NONE",
+ "ASSET_START_TIME_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "streamingServingUrl": {
+ "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "transparency": {
+ "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.",
+ "type": "boolean"
+ },
+ "verticallyLocked": {
+ "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "windowMode": {
+ "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
+ "enum": [
+ "OPAQUE",
+ "WINDOW",
+ "TRANSPARENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "zIndex": {
+ "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "zipFilename": {
+ "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ },
+ "zipFilesize": {
+ "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetId": {
+ "description": "Creative Asset ID.",
+ "id": "CreativeAssetId",
+ "properties": {
+ "name": {
+ "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
+ "enum": [
+ "IMAGE",
+ "FLASH",
+ "VIDEO",
+ "HTML",
+ "HTML_IMAGE",
+ "AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetMetadata": {
+ "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
+ "id": "CreativeAssetMetadata",
+ "properties": {
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "ID of the creative asset. This is a required field."
+ },
+ "clickTags": {
+ "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
+ "type": "string"
+ },
+ "warnedValidationRules": {
+ "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
+ "items": {
+ "enum": [
+ "CLICK_TAG_NON_TOP_LEVEL",
+ "CLICK_TAG_MISSING",
+ "CLICK_TAG_MORE_THAN_ONE",
+ "CLICK_TAG_INVALID",
+ "ORPHANED_ASSET",
+ "PRIMARY_HTML_MISSING",
+ "EXTERNAL_FILE_REFERENCED",
+ "MRAID_REFERENCED",
+ "ADMOB_REFERENCED",
+ "FILE_TYPE_INVALID",
+ "ZIP_INVALID",
+ "LINKED_FILE_NOT_FOUND",
+ "MAX_FLASH_VERSION_11",
+ "NOT_SSL_COMPLIANT",
+ "FILE_DETAIL_EMPTY",
+ "ASSET_INVALID",
+ "GWD_PROPERTIES_INVALID",
+ "ENABLER_UNSUPPORTED_METHOD_DCM",
+ "ASSET_FORMAT_UNSUPPORTED_DCM",
+ "COMPONENT_UNSUPPORTED_DCM",
+ "HTML5_FEATURE_UNSUPPORTED",
+ "CLICK_TAG_IN_GWD",
+ "CLICK_TAG_HARD_CODED",
+ "SVG_INVALID",
+ "CLICK_TAG_IN_RICH_MEDIA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetSelection": {
+ "description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "CreativeAssetSelection",
+ "properties": {
+ "defaultAssetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rules": {
+ "description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssignment": {
+ "description": "Creative Assignment.",
+ "id": "CreativeAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "applyEventTags": {
+ "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
+ "type": "boolean"
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of the creative assignment."
+ },
+ "companionCreativeOverrides": {
+ "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
+ "items": {
+ "$ref": "CompanionClickThroughOverride"
+ },
+ "type": "array"
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeId": {
+ "description": "ID of the creative to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "richMediaExitOverrides": {
+ "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
+ "items": {
+ "$ref": "RichMediaExitOverride"
+ },
+ "type": "array"
+ },
+ "sequence": {
+ "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "weight": {
+ "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "CreativeClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeCustomEvent": {
+ "description": "Creative Custom Event.",
+ "id": "CreativeCustomEvent",
+ "properties": {
+ "advertiserCustomEventId": {
+ "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserCustomEventName": {
+ "description": "User-entered name for the event.",
+ "type": "string"
+ },
+ "advertiserCustomEventType": {
+ "description": "Type of the event. This is a read-only field.",
+ "enum": [
+ "ADVERTISER_EVENT_TIMER",
+ "ADVERTISER_EVENT_EXIT",
+ "ADVERTISER_EVENT_COUNTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkLabel": {
+ "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type used by the creative.This is a read-only field.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "exitClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Exit click-through URL for the event. This field is used only for exit events."
+ },
+ "id": {
+ "description": "ID of this event. This is a required field and should not be modified after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "popupWindowProperties": {
+ "$ref": "PopupWindowProperties",
+ "description": "Properties for rich media popup windows. This field is used only for exit events."
+ },
+ "targetType": {
+ "description": "Target type used by the event.",
+ "enum": [
+ "TARGET_BLANK",
+ "TARGET_TOP",
+ "TARGET_SELF",
+ "TARGET_PARENT",
+ "TARGET_POPUP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "videoReportingId": {
+ "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeField": {
+ "description": "Contains properties of a creative field.",
+ "id": "CreativeField",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative field. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this creative field. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldAssignment": {
+ "description": "Creative Field Assignment.",
+ "id": "CreativeFieldAssignment",
+ "properties": {
+ "creativeFieldId": {
+ "description": "ID of the creative field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeFieldValueId": {
+ "description": "ID of the creative field value.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValue": {
+ "description": "Contains properties of a creative field value.",
+ "id": "CreativeFieldValue",
+ "properties": {
+ "id": {
+ "description": "ID of this creative field value. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValuesListResponse": {
+ "description": "Creative Field Value List Response",
+ "id": "CreativeFieldValuesListResponse",
+ "properties": {
+ "creativeFieldValues": {
+ "description": "Creative field value collection.",
+ "items": {
+ "$ref": "CreativeFieldValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldsListResponse": {
+ "description": "Creative Field List Response",
+ "id": "CreativeFieldsListResponse",
+ "properties": {
+ "creativeFields": {
+ "description": "Creative field collection.",
+ "items": {
+ "$ref": "CreativeField"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroup": {
+ "description": "Contains properties of a creative group.",
+ "id": "CreativeGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "groupNumber": {
+ "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this creative group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupAssignment": {
+ "description": "Creative Group Assignment.",
+ "id": "CreativeGroupAssignment",
+ "properties": {
+ "creativeGroupId": {
+ "description": "ID of the creative group to be assigned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeGroupNumber": {
+ "description": "Creative group number of the creative group assignment.",
+ "enum": [
+ "CREATIVE_GROUP_ONE",
+ "CREATIVE_GROUP_TWO"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupsListResponse": {
+ "description": "Creative Group List Response",
+ "id": "CreativeGroupsListResponse",
+ "properties": {
+ "creativeGroups": {
+ "description": "Creative group collection.",
+ "items": {
+ "$ref": "CreativeGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeOptimizationConfiguration": {
+ "description": "Creative optimization settings.",
+ "id": "CreativeOptimizationConfiguration",
+ "properties": {
+ "id": {
+ "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.",
+ "type": "string"
+ },
+ "optimizationActivitys": {
+ "description": "List of optimization activities associated with this configuration.",
+ "items": {
+ "$ref": "OptimizationActivity"
+ },
+ "type": "array"
+ },
+ "optimizationModel": {
+ "description": "Optimization model for this configuration.",
+ "enum": [
+ "CLICK",
+ "POST_CLICK",
+ "POST_IMPRESSION",
+ "POST_CLICK_AND_IMPRESSION",
+ "VIDEO_COMPLETION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeRotation": {
+ "description": "Creative Rotation.",
+ "id": "CreativeRotation",
+ "properties": {
+ "creativeAssignments": {
+ "description": "Creative assignments in this creative rotation.",
+ "items": {
+ "$ref": "CreativeAssignment"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfigurationId": {
+ "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
+ "enum": [
+ "CREATIVE_ROTATION_TYPE_SEQUENTIAL",
+ "CREATIVE_ROTATION_TYPE_RANDOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "weightCalculationStrategy": {
+ "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
+ "enum": [
+ "WEIGHT_STRATEGY_EQUAL",
+ "WEIGHT_STRATEGY_CUSTOM",
+ "WEIGHT_STRATEGY_HIGHEST_CTR",
+ "WEIGHT_STRATEGY_OPTIMIZED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativesListResponse": {
+ "description": "Creative List Response",
+ "id": "CreativesListResponse",
+ "properties": {
+ "creatives": {
+ "description": "Creative collection.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CrossDimensionReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
+ "id": "CrossDimensionReachReportCompatibleFields",
+ "properties": {
+ "breakdown": {
+ "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "overlapMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomFloodlightVariable": {
+ "description": "A custom floodlight variable.",
+ "id": "CustomFloodlightVariable",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomRichMediaEvents": {
+ "description": "Represents a Custom Rich Media Events group.",
+ "id": "CustomRichMediaEvents",
+ "properties": {
+ "filteredEventIds": {
+ "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetric": {
+ "description": "Custom Viewability Metric",
+ "id": "CustomViewabilityMetric",
+ "properties": {
+ "configuration": {
+ "$ref": "CustomViewabilityMetricConfiguration",
+ "description": "Configuration of the custom viewability metric."
+ },
+ "id": {
+ "description": "ID of the custom viewability metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the custom viewability metric.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetricConfiguration": {
+ "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
+ "id": "CustomViewabilityMetricConfiguration",
+ "properties": {
+ "audible": {
+ "description": "Whether the video must be audible to count an impression.",
+ "type": "boolean"
+ },
+ "timeMillis": {
+ "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "timePercent": {
+ "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "viewabilityPercent": {
+ "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "Represents a date range.",
+ "id": "DateRange",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dateRange.",
+ "type": "string"
+ },
+ "relativeDateRange": {
+ "description": "The date range relative to the date of when the report is run.",
+ "enum": [
+ "TODAY",
+ "YESTERDAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "LAST_24_MONTHS",
+ "LAST_14_DAYS",
+ "LAST_60_DAYS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DayPartTargeting": {
+ "description": "Day Part Targeting.",
+ "id": "DayPartTargeting",
+ "properties": {
+ "daysOfWeek": {
+ "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ",
+ "items": {
+ "enum": [
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hoursOfDay": {
+ "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "userLocalTime": {
+ "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeepLink": {
+ "description": "Contains information about a landing page deep link.",
+ "id": "DeepLink",
+ "properties": {
+ "appUrl": {
+ "description": "The URL of the mobile app being linked to.",
+ "type": "string"
+ },
+ "fallbackUrl": {
+ "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".",
+ "type": "string"
+ },
+ "mobileApp": {
+ "$ref": "MobileApp",
+ "description": "The mobile app targeted by this deep link."
+ },
+ "remarketingListIds": {
+ "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DefaultClickThroughEventTagProperties": {
+ "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
+ "id": "DefaultClickThroughEventTagProperties",
+ "properties": {
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
+ "format": "int64",
+ "type": "string"
+ },
+ "overrideInheritedEventTag": {
+ "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeliverySchedule": {
+ "description": "Delivery Schedule.",
+ "id": "DeliverySchedule",
+ "properties": {
+ "frequencyCap": {
+ "$ref": "FrequencyCap",
+ "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
+ },
+ "hardCutoff": {
+ "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.",
+ "type": "boolean"
+ },
+ "impressionRatio": {
+ "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "priority": {
+ "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
+ "enum": [
+ "AD_PRIORITY_01",
+ "AD_PRIORITY_02",
+ "AD_PRIORITY_03",
+ "AD_PRIORITY_04",
+ "AD_PRIORITY_05",
+ "AD_PRIORITY_06",
+ "AD_PRIORITY_07",
+ "AD_PRIORITY_08",
+ "AD_PRIORITY_09",
+ "AD_PRIORITY_10",
+ "AD_PRIORITY_11",
+ "AD_PRIORITY_12",
+ "AD_PRIORITY_13",
+ "AD_PRIORITY_14",
+ "AD_PRIORITY_15",
+ "AD_PRIORITY_16"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DfpSettings": {
+ "description": "Google Ad Manager Settings",
+ "id": "DfpSettings",
+ "properties": {
+ "dfpNetworkCode": {
+ "description": "Ad Manager network code for this directory site.",
+ "type": "string"
+ },
+ "dfpNetworkName": {
+ "description": "Ad Manager network name for this directory site.",
+ "type": "string"
+ },
+ "programmaticPlacementAccepted": {
+ "description": "Whether this directory site accepts programmatic placements.",
+ "type": "boolean"
+ },
+ "pubPaidPlacementAccepted": {
+ "description": "Whether this directory site accepts publisher-paid tags.",
+ "type": "boolean"
+ },
+ "publisherPortalOnly": {
+ "description": "Whether this directory site is available only via Publisher Portal.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "Represents a dimension.",
+ "id": "Dimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The dimension name, e.g. dfa:advertiser",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionFilter": {
+ "description": "Represents a dimension filter.",
+ "id": "DimensionFilter",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension to filter.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension to filter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValue": {
+ "description": "Represents a DimensionValue resource.",
+ "id": "DimensionValue",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID associated with the value if available.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "EXACT",
+ "BEGINS_WITH",
+ "CONTAINS",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueList": {
+ "description": "Represents the list of DimensionValue resources.",
+ "id": "DimensionValueList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The dimension values returned in this response.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueRequest": {
+ "description": "Represents a DimensionValuesRequest.",
+ "id": "DimensionValueRequest",
+ "properties": {
+ "dimensionName": {
+ "annotations": {
+ "required": [
+ "dfareporting.dimensionValues.query"
+ ]
+ },
+ "description": "The name of the dimension for which values should be requested.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The list of filters by which to filter values. The filters are ANDed.",
+ "items": {
+ "$ref": "DimensionFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySite": {
+ "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
+ "id": "DirectorySite",
+ "properties": {
+ "active": {
+ "description": "Whether this directory site is active.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this directory site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
+ },
+ "inpageTagFormats": {
+ "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ",
+ "items": {
+ "enum": [
+ "STANDARD",
+ "IFRAME_JAVASCRIPT_INPAGE",
+ "INTERNAL_REDIRECT_INPAGE",
+ "JAVASCRIPT_INPAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "interstitialTagFormats": {
+ "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "IFRAME_JAVASCRIPT_INTERSTITIAL",
+ "INTERNAL_REDIRECT_INTERSTITIAL",
+ "JAVASCRIPT_INTERSTITIAL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this directory site.",
+ "type": "string"
+ },
+ "settings": {
+ "$ref": "DirectorySiteSettings",
+ "description": "Directory site settings."
+ },
+ "url": {
+ "description": "URL of this directory site.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySiteSettings": {
+ "description": "Directory Site Settings",
+ "id": "DirectorySiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether this directory site has disabled active view creatives.",
+ "type": "boolean"
+ },
+ "dfpSettings": {
+ "$ref": "DfpSettings",
+ "description": "Directory site Ad Manager settings."
+ },
+ "instreamVideoPlacementAccepted": {
+ "description": "Whether this site accepts in-stream video ads.",
+ "type": "boolean"
+ },
+ "interstitialPlacementAccepted": {
+ "description": "Whether this site accepts interstitial ads.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySitesListResponse": {
+ "description": "Directory Site List Response",
+ "id": "DirectorySitesListResponse",
+ "properties": {
+ "directorySites": {
+ "description": "Directory site collection.",
+ "items": {
+ "$ref": "DirectorySite"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKey": {
+ "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
+ "id": "DynamicTargetingKey",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKeysListResponse": {
+ "description": "Dynamic Targeting Key List Response",
+ "id": "DynamicTargetingKeysListResponse",
+ "properties": {
+ "dynamicTargetingKeys": {
+ "description": "Dynamic targeting key collection.",
+ "items": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EncryptionInfo": {
+ "description": "A description of how user IDs are encrypted.",
+ "id": "EncryptionInfo",
+ "properties": {
+ "encryptionEntityId": {
+ "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "encryptionEntityType": {
+ "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
+ "enum": [
+ "ENCRYPTION_ENTITY_TYPE_UNKNOWN",
+ "DCM_ACCOUNT",
+ "DCM_ADVERTISER",
+ "DBM_PARTNER",
+ "DBM_ADVERTISER",
+ "ADWORDS_CUSTOMER",
+ "DFP_NETWORK_CODE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "encryptionSource": {
+ "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
+ "enum": [
+ "ENCRYPTION_SCOPE_UNKNOWN",
+ "AD_SERVING",
+ "DATA_TRANSFER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTag": {
+ "description": "Contains properties of an event tag.",
+ "id": "EventTag",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "campaignId": {
+ "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "enabledByDefault": {
+ "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.",
+ "type": "boolean"
+ },
+ "excludeFromAdxRequests": {
+ "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this event tag. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "siteFilterType": {
+ "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
+ "enum": [
+ "WHITELIST",
+ "BLACKLIST"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sslCompliant": {
+ "description": "Whether this tag is SSL-compliant or not. This is a read-only field.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
+ "enum": [
+ "ENABLED",
+ "DISABLED"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.",
+ "type": "string"
+ },
+ "urlEscapeLevels": {
+ "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagOverride": {
+ "description": "Event tag override information.",
+ "id": "EventTagOverride",
+ "properties": {
+ "enabled": {
+ "description": "Whether this override is enabled.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag override. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagsListResponse": {
+ "description": "Event Tag List Response",
+ "id": "EventTagsListResponse",
+ "properties": {
+ "eventTags": {
+ "description": "Event tag collection.",
+ "items": {
+ "$ref": "EventTag"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "File": {
+ "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
+ "id": "File",
+ "properties": {
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename of the file.",
+ "type": "string"
+ },
+ "format": {
+ "description": "The output format of the report. Only available once the file is available.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of this report file.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "description": "The timestamp in milliseconds since epoch when this file was last modified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report this file was generated from.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the report file.",
+ "enum": [
+ "PROCESSING",
+ "REPORT_AVAILABLE",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "urls": {
+ "description": "The URLs where the completed report file can be downloaded.",
+ "properties": {
+ "apiUrl": {
+ "description": "The URL for downloading the report data through the API.",
+ "type": "string"
+ },
+ "browserUrl": {
+ "description": "The URL for downloading the report data through a browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "FileList": {
+ "description": "List of files for a report.",
+ "id": "FileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The files returned in this response.",
+ "items": {
+ "$ref": "File"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Flight": {
+ "description": "Flight",
+ "id": "Flight",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "rateOrCost": {
+ "description": "Rate or cost of this flight.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this flight.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesGenerateTagResponse": {
+ "description": "Floodlight Activity GenerateTag Response",
+ "id": "FloodlightActivitiesGenerateTagResponse",
+ "properties": {
+ "floodlightActivityTag": {
+ "description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
+ "type": "string"
+ },
+ "globalSiteTagGlobalSnippet": {
+ "description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesListResponse": {
+ "description": "Floodlight Activity List Response",
+ "id": "FloodlightActivitiesListResponse",
+ "properties": {
+ "floodlightActivities": {
+ "description": "Floodlight activity collection.",
+ "items": {
+ "$ref": "FloodlightActivity"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivity": {
+ "description": "Contains properties of a Floodlight activity.",
+ "id": "FloodlightActivity",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "cacheBustingType": {
+ "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
+ "enum": [
+ "JAVASCRIPT",
+ "ACTIVE_SERVER_PAGE",
+ "JSP",
+ "PHP",
+ "COLD_FUSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "countingMethod": {
+ "description": "Counting method for conversions for this floodlight activity. This is a required field.",
+ "enum": [
+ "STANDARD_COUNTING",
+ "UNIQUE_COUNTING",
+ "SESSION_COUNTING",
+ "TRANSACTIONS_COUNTING",
+ "ITEMS_SOLD_COUNTING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "defaultTags": {
+ "description": "Dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityDynamicTag"
+ },
+ "type": "array"
+ },
+ "expectedUrl": {
+ "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
+ "type": "string"
+ },
+ "floodlightActivityGroupId": {
+ "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityGroupName": {
+ "description": "Name of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupTagString": {
+ "description": "Tag string of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupType": {
+ "description": "Type of the associated floodlight activity group. This is a read-only field.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "floodlightTagType": {
+ "description": "The type of Floodlight tag this activity will generate. This is a required field.",
+ "enum": [
+ "IFRAME",
+ "IMAGE",
+ "GLOBAL_SITE_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "hidden": {
+ "description": "Whether this activity is archived.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "General notes or implementation instructions for the tag.",
+ "type": "string"
+ },
+ "publisherTags": {
+ "description": "Publisher dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityPublisherDynamicTag"
+ },
+ "type": "array"
+ },
+ "secure": {
+ "description": "Whether this tag should use SSL.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this floodlight activity must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormat": {
+ "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
+ "enum": [
+ "HTML",
+ "XHTML"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "userDefinedVariableTypes": {
+ "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
+ "items": {
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityDynamicTag": {
+ "description": "Dynamic Tag",
+ "id": "FloodlightActivityDynamicTag",
+ "properties": {
+ "id": {
+ "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this tag.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Tag code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroup": {
+ "description": "Contains properties of a Floodlight activity group.",
+ "id": "FloodlightActivityGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroupsListResponse": {
+ "description": "Floodlight Activity Group List Response",
+ "id": "FloodlightActivityGroupsListResponse",
+ "properties": {
+ "floodlightActivityGroups": {
+ "description": "Floodlight activity group collection.",
+ "items": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityPublisherDynamicTag": {
+ "description": "Publisher Dynamic Tag",
+ "id": "FloodlightActivityPublisherDynamicTag",
+ "properties": {
+ "clickThrough": {
+ "description": "Whether this tag is applicable only for click-throughs.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dynamicTag": {
+ "$ref": "FloodlightActivityDynamicTag",
+ "description": "Dynamic floodlight tag."
+ },
+ "siteId": {
+ "description": "Site ID of this dynamic tag.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "viewThrough": {
+ "description": "Whether this tag is applicable only for view-throughs.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfiguration": {
+ "description": "Contains properties of a Floodlight configuration.",
+ "id": "FloodlightConfiguration",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "analyticsDataSharingEnabled": {
+ "description": "Whether advertiser data is shared with Google Analytics.",
+ "type": "boolean"
+ },
+ "customViewabilityMetric": {
+ "$ref": "CustomViewabilityMetric",
+ "description": "Custom Viewability metric for the floodlight configuration."
+ },
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "firstDayOfWeek": {
+ "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
+ "enum": [
+ "MONDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "inAppAttributionTrackingEnabled": {
+ "description": "Whether in-app attribution tracking is enabled.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
+ "type": "string"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this floodlight configuration."
+ },
+ "naturalSearchConversionAttributionOption": {
+ "description": "Types of attribution options for natural search conversions.",
+ "enum": [
+ "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "omnitureSettings": {
+ "$ref": "OmnitureSettings",
+ "description": "Settings for Campaign Manager Omniture integration."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagSettings": {
+ "$ref": "TagSettings",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "thirdPartyAuthenticationTokens": {
+ "description": "List of third-party authentication tokens enabled for this configuration.",
+ "items": {
+ "$ref": "ThirdPartyAuthenticationToken"
+ },
+ "type": "array"
+ },
+ "userDefinedVariableConfigurations": {
+ "description": "List of user defined variables enabled for this configuration.",
+ "items": {
+ "$ref": "UserDefinedVariableConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfigurationsListResponse": {
+ "description": "Floodlight Configuration List Response",
+ "id": "FloodlightConfigurationsListResponse",
+ "properties": {
+ "floodlightConfigurations": {
+ "description": "Floodlight configuration collection.",
+ "items": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
+ "id": "FloodlightReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FrequencyCap": {
+ "description": "Frequency Cap.",
+ "id": "FrequencyCap",
+ "properties": {
+ "duration": {
+ "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "impressions": {
+ "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FsCommand": {
+ "description": "FsCommand.",
+ "id": "FsCommand",
+ "properties": {
+ "left": {
+ "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "positionOption": {
+ "description": "Position in the browser where the window will open.",
+ "enum": [
+ "CENTERED",
+ "DISTANCE_FROM_TOP_LEFT_CORNER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "top": {
+ "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowHeight": {
+ "description": "Height of the window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowWidth": {
+ "description": "Width of the window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GeoTargeting": {
+ "description": "Geographical Targeting.",
+ "id": "GeoTargeting",
+ "properties": {
+ "cities": {
+ "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "countries": {
+ "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "excludeCountries": {
+ "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.",
+ "type": "boolean"
+ },
+ "metros": {
+ "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ },
+ "postalCodes": {
+ "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ },
+ "regions": {
+ "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItem": {
+ "description": "Represents a buy from the Planning inventory store.",
+ "id": "InventoryItem",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adSlots": {
+ "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
+ "items": {
+ "$ref": "AdSlot"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "Content category ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedClickThroughRate": {
+ "description": "Estimated click-through rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedConversionRate": {
+ "description": "Estimated conversion rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inPlan": {
+ "description": "Whether this inventory item is in plan.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this inventory item."
+ },
+ "name": {
+ "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.",
+ "type": "string"
+ },
+ "negotiationChannelId": {
+ "description": "Negotiation channel ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "Order ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "Placement strategy ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricing": {
+ "$ref": "Pricing",
+ "description": "Pricing of this inventory item."
+ },
+ "projectId": {
+ "description": "Project ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rfpId": {
+ "description": "RFP ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "ID of the site this inventory item is associated with.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItemsListResponse": {
+ "description": "Inventory item List Response",
+ "id": "InventoryItemsListResponse",
+ "properties": {
+ "inventoryItems": {
+ "description": "Inventory item collection",
+ "items": {
+ "$ref": "InventoryItem"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "KeyValueTargetingExpression": {
+ "description": "Key Value Targeting Expression.",
+ "id": "KeyValueTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Keyword expression being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LandingPage": {
+ "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
+ "id": "LandingPage",
+ "properties": {
+ "advertiserId": {
+ "description": "Advertiser ID of this landing page. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Whether this landing page has been archived.",
+ "type": "boolean"
+ },
+ "deepLinks": {
+ "description": "Links that will direct the user to a mobile app, if installed.",
+ "items": {
+ "$ref": "DeepLink"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this landing page. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of this landing page. This is a required field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Language": {
+ "description": "Contains information about a language that can be targeted by ads.",
+ "id": "Language",
+ "properties": {
+ "id": {
+ "description": "Language ID of this language. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this language.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LanguageTargeting": {
+ "description": "Language Targeting.",
+ "id": "LanguageTargeting",
+ "properties": {
+ "languages": {
+ "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LanguagesListResponse": {
+ "description": "Language List Response",
+ "id": "LanguagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Language collection.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LastModifiedInfo": {
+ "description": "Modification timestamp.",
+ "id": "LastModifiedInfo",
+ "properties": {
+ "time": {
+ "description": "Timestamp of the last change in milliseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationClause": {
+ "description": "A group clause made up of list population terms representing constraints joined by ORs.",
+ "id": "ListPopulationClause",
+ "properties": {
+ "terms": {
+ "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationTerm"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationRule": {
+ "description": "Remarketing List Population Rule.",
+ "id": "ListPopulationRule",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityName": {
+ "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "listPopulationClauses": {
+ "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationClause"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationTerm": {
+ "description": "Remarketing List Population Rule Term.",
+ "id": "ListPopulationTerm",
+ "properties": {
+ "contains": {
+ "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
+ "type": "boolean"
+ },
+ "negation": {
+ "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "enum": [
+ "NUM_EQUALS",
+ "NUM_LESS_THAN",
+ "NUM_LESS_THAN_EQUAL",
+ "NUM_GREATER_THAN",
+ "NUM_GREATER_THAN_EQUAL",
+ "STRING_EQUALS",
+ "STRING_CONTAINS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
+ "enum": [
+ "CUSTOM_VARIABLE_TERM",
+ "LIST_MEMBERSHIP_TERM",
+ "REFERRER_TERM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ },
+ "variableFriendlyName": {
+ "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
+ "type": "string"
+ },
+ "variableName": {
+ "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListTargetingExpression": {
+ "description": "Remarketing List Targeting Expression.",
+ "id": "ListTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Expression describing which lists are being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LookbackConfiguration": {
+ "description": "Lookback configuration settings.",
+ "id": "LookbackConfiguration",
+ "properties": {
+ "clickDuration": {
+ "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "postImpressionActivitiesDuration": {
+ "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Metric": {
+ "description": "Represents a metric.",
+ "id": "Metric",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#metric.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The metric name, e.g. dfa:impressions",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metro": {
+ "description": "Contains information about a metro region that can be targeted by ads.",
+ "id": "Metro",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this metro region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this metro region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this metro region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dmaId": {
+ "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro code of this metro region. This is equivalent to dma_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this metro region.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetrosListResponse": {
+ "description": "Metro List Response",
+ "id": "MetrosListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
+ "type": "string"
+ },
+ "metros": {
+ "description": "Metro collection.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MobileApp": {
+ "description": "Contains information about a mobile app. Used as a landing page deep link.",
+ "id": "MobileApp",
+ "properties": {
+ "directory": {
+ "description": "Mobile app directory.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile app.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
+ "type": "string"
+ },
+ "publisherName": {
+ "description": "Publisher name.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this mobile app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileAppsListResponse": {
+ "description": "Mobile app List Response",
+ "id": "MobileAppsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
+ "type": "string"
+ },
+ "mobileApps": {
+ "description": "Mobile apps collection.",
+ "items": {
+ "$ref": "MobileApp"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarrier": {
+ "description": "Contains information about a mobile carrier that can be targeted by ads.",
+ "id": "MobileCarrier",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this mobile carrier belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this mobile carrier belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile carrier.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this mobile carrier.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarriersListResponse": {
+ "description": "Mobile Carrier List Response",
+ "id": "MobileCarriersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
+ "type": "string"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carrier collection.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ObjectFilter": {
+ "description": "Object Filter.",
+ "id": "ObjectFilter",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
+ "enum": [
+ "NONE",
+ "ASSIGNED",
+ "ALL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OffsetPosition": {
+ "description": "Offset Position.",
+ "id": "OffsetPosition",
+ "properties": {
+ "left": {
+ "description": "Offset distance from left side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "top": {
+ "description": "Offset distance from top side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OmnitureSettings": {
+ "description": "Omniture Integration Settings.",
+ "id": "OmnitureSettings",
+ "properties": {
+ "omnitureCostDataEnabled": {
+ "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
+ "type": "boolean"
+ },
+ "omnitureIntegrationEnabled": {
+ "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystem": {
+ "description": "Contains information about an operating system that can be targeted by ads.",
+ "id": "OperatingSystem",
+ "properties": {
+ "dartId": {
+ "description": "DART ID of this operating system. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "desktop": {
+ "description": "Whether this operating system is for desktop.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
+ "type": "string"
+ },
+ "mobile": {
+ "description": "Whether this operating system is for mobile.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Name of this operating system.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersion": {
+ "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
+ "id": "OperatingSystemVersion",
+ "properties": {
+ "id": {
+ "description": "ID of this operating system version.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version (leftmost number) of this operating system version.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version (number after the first dot) of this operating system version.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this operating system version.",
+ "type": "string"
+ },
+ "operatingSystem": {
+ "$ref": "OperatingSystem",
+ "description": "Operating system of this operating system version."
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersionsListResponse": {
+ "description": "Operating System Version List Response",
+ "id": "OperatingSystemVersionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system version collection.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemsListResponse": {
+ "description": "Operating System List Response",
+ "id": "OperatingSystemsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystems": {
+ "description": "Operating system collection.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OptimizationActivity": {
+ "description": "Creative optimization activity.",
+ "id": "OptimizationActivity",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID of this optimization activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
+ },
+ "weight": {
+ "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Order": {
+ "description": "Describes properties of a Planning order.",
+ "id": "Order",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approverUserProfileIds": {
+ "description": "IDs for users that have to approve documents created for this order.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "buyerInvoiceId": {
+ "description": "Buyer invoice ID associated with this order.",
+ "type": "string"
+ },
+ "buyerOrganizationName": {
+ "description": "Name of the buyer organization.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "Comments in this order.",
+ "type": "string"
+ },
+ "contacts": {
+ "description": "Contacts for this order.",
+ "items": {
+ "$ref": "OrderContact"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this order. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this order."
+ },
+ "name": {
+ "description": "Name of this order.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Notes of this order.",
+ "type": "string"
+ },
+ "planningTermId": {
+ "description": "ID of the terms and conditions template used in this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sellerOrderId": {
+ "description": "Seller order ID associated with this order.",
+ "type": "string"
+ },
+ "sellerOrganizationName": {
+ "description": "Name of the seller organization.",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Site IDs this order is associated with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "siteNames": {
+ "description": "Free-form site names this order is associated with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "termsAndConditions": {
+ "description": "Terms and conditions of this order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderContact": {
+ "description": "Contact of an order.",
+ "id": "OrderContact",
+ "properties": {
+ "contactInfo": {
+ "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "Name of this contact.",
+ "type": "string"
+ },
+ "contactTitle": {
+ "description": "Title of this contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Type of this contact.",
+ "enum": [
+ "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
+ "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
+ "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "signatureUserProfileId": {
+ "description": "ID of the user profile containing the signature that will be embedded into order documents.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocument": {
+ "description": "Contains properties of a Planning order document.",
+ "id": "OrderDocument",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "amendedOrderDocumentId": {
+ "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approvedByUserProfileIds": {
+ "description": "IDs of users who have approved this order document.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "cancelled": {
+ "description": "Whether this order document is cancelled.",
+ "type": "boolean"
+ },
+ "createdInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this order document."
+ },
+ "effectiveDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
+ "type": "string"
+ },
+ "lastSentRecipients": {
+ "description": "List of email addresses that received the last sent document.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "lastSentTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "ID of the order from which this order document is created.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "signed": {
+ "description": "Whether this order document has been signed.",
+ "type": "boolean"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this order document.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this order document",
+ "enum": [
+ "PLANNING_ORDER_TYPE_INSERTION_ORDER",
+ "PLANNING_ORDER_TYPE_CHANGE_ORDER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocumentsListResponse": {
+ "description": "Order document List Response",
+ "id": "OrderDocumentsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orderDocuments": {
+ "description": "Order document collection",
+ "items": {
+ "$ref": "OrderDocument"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersListResponse": {
+ "description": "Order List Response",
+ "id": "OrdersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orders": {
+ "description": "Order collection.",
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathToConversionReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
+ "id": "PathToConversionReportCompatibleFields",
+ "properties": {
+ "conversionDimensions": {
+ "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "customFloodlightVariables": {
+ "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "perInteractionDimensions": {
+ "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Placement": {
+ "description": "Contains properties of a placement.",
+ "id": "Placement",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement. This field is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "comment": {
+ "description": "Comments for this placement.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this placement. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement. This is a read-only field."
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this placement."
+ },
+ "name": {
+ "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.",
+ "type": "string"
+ },
+ "paymentApproved": {
+ "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
+ "type": "boolean"
+ },
+ "paymentSource": {
+ "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementGroupId": {
+ "description": "ID of this placement's group, if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementGroupIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
+ },
+ "primary": {
+ "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
+ "type": "boolean"
+ },
+ "publisherUpdateInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the last publisher update. This is a read-only field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
+ },
+ "sslRequired": {
+ "description": "Whether creatives assigned to this placement must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Third-party placement status.",
+ "enum": [
+ "PENDING_REVIEW",
+ "PAYMENT_ACCEPTED",
+ "PAYMENT_REJECTED",
+ "ACKNOWLEDGE_REJECTION",
+ "ACKNOWLEDGE_ACCEPTANCE",
+ "DRAFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
+ "items": {
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Tag settings for this placement."
+ },
+ "videoActiveViewOptOut": {
+ "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
+ "type": "boolean"
+ },
+ "videoSettings": {
+ "$ref": "VideoSettings",
+ "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
+ },
+ "vpaidAdapterChoice": {
+ "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementAssignment": {
+ "description": "Placement Assignment.",
+ "id": "PlacementAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "placementId": {
+ "description": "ID of the placement to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
+ },
+ "sslRequired": {
+ "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroup": {
+ "description": "Contains properties of a package or roadblock.",
+ "id": "PlacementGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement group is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement group. This field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "childPlacementIds": {
+ "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "comment": {
+ "description": "Comments for this placement group.",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement group. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement group. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement group. This field is required on insertion."
+ },
+ "primaryPlacementId": {
+ "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
+ "format": "int64",
+ "type": "string"
+ },
+ "primaryPlacementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroupsListResponse": {
+ "description": "Placement Group List Response",
+ "id": "PlacementGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "PricingSchedulePricingPeriod": {
- "description": "Pricing Period",
- "id": "PricingSchedulePricingPeriod",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "pricingComment": {
- "description": "Comments for this pricing period.",
- "type": "string"
- },
- "rateOrCostNanos": {
- "description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "units": {
- "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "placementGroups": {
+ "description": "Placement group collection.",
+ "items": {
+ "$ref": "PlacementGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategiesListResponse": {
+ "description": "Placement Strategy List Response",
+ "id": "PlacementStrategiesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "Project": {
- "description": "Contains properties of a Planning project.",
- "id": "Project",
- "properties": {
- "accountId": {
- "description": "Account ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "audienceAgeGroup": {
- "description": "Audience age group of this project.",
- "enum": [
- "PLANNING_AUDIENCE_AGE_18_24",
- "PLANNING_AUDIENCE_AGE_25_34",
- "PLANNING_AUDIENCE_AGE_35_44",
- "PLANNING_AUDIENCE_AGE_45_54",
- "PLANNING_AUDIENCE_AGE_55_64",
- "PLANNING_AUDIENCE_AGE_65_OR_MORE",
- "PLANNING_AUDIENCE_AGE_UNKNOWN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "audienceGender": {
- "description": "Audience gender of this project.",
- "enum": [
- "PLANNING_AUDIENCE_GENDER_MALE",
- "PLANNING_AUDIENCE_GENDER_FEMALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "budget": {
- "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
- "format": "int64",
- "type": "string"
- },
- "clientBillingCode": {
- "description": "Client billing code of this project.",
- "type": "string"
- },
- "clientName": {
- "description": "Name of the project client.",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "id": {
- "description": "ID of this project. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this project."
- },
- "name": {
- "description": "Name of this project.",
- "type": "string"
- },
- "overview": {
- "description": "Overview of this project.",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "targetClicks": {
- "description": "Number of clicks that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetConversions": {
- "description": "Number of conversions that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpaNanos": {
- "description": "CPA that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpcNanos": {
- "description": "CPC that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpmActiveViewNanos": {
- "description": "vCPM from Active View that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpmNanos": {
- "description": "CPM that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetImpressions": {
- "description": "Number of impressions that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "placementStrategies": {
+ "description": "Placement strategy collection.",
+ "items": {
+ "$ref": "PlacementStrategy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategy": {
+ "description": "Contains properties of a placement strategy.",
+ "id": "PlacementStrategy",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementTag": {
+ "description": "Placement Tag",
+ "id": "PlacementTag",
+ "properties": {
+ "placementId": {
+ "description": "Placement ID",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagDatas": {
+ "description": "Tags generated for this placement.",
+ "items": {
+ "$ref": "TagData"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsGenerateTagsResponse": {
+ "description": "Placement GenerateTags Response",
+ "id": "PlacementsGenerateTagsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
+ "type": "string"
+ },
+ "placementTags": {
+ "description": "Set of generated tags for the specified placements.",
+ "items": {
+ "$ref": "PlacementTag"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsListResponse": {
+ "description": "Placement List Response",
+ "id": "PlacementsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "ProjectsListResponse": {
- "description": "Project List Response",
- "id": "ProjectsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "projects": {
- "description": "Project collection.",
- "items": {
- "$ref": "Project"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReachReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "id": "ReachReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "pivotedActivityMetrics": {
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "reachByFrequencyMetrics": {
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Recipient": {
- "description": "Represents a recipient.",
- "id": "Recipient",
- "properties": {
- "deliveryType": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The delivery type for the recipient.",
- "enum": [
- "LINK",
- "ATTACHMENT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "email": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The email address of the recipient.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "type": "string"
- }
- },
- "type": "object"
+ "placements": {
+ "description": "Placement collection.",
+ "items": {
+ "$ref": "Placement"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformType": {
+ "description": "Contains information about a platform type that can be targeted by ads.",
+ "id": "PlatformType",
+ "properties": {
+ "id": {
+ "description": "ID of this platform type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this platform type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformTypesListResponse": {
+ "description": "Platform Type List Response",
+ "id": "PlatformTypesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
+ "type": "string"
},
- "Region": {
- "description": "Contains information about a region that can be targeted by ads.",
- "id": "Region",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this region belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this region belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this region.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this region.",
- "type": "string"
- },
- "regionCode": {
- "description": "Region code.",
- "type": "string"
- }
- },
- "type": "object"
+ "platformTypes": {
+ "description": "Platform type collection.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PopupWindowProperties": {
+ "description": "Popup Window Properties.",
+ "id": "PopupWindowProperties",
+ "properties": {
+ "dimension": {
+ "$ref": "Size",
+ "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
+ },
+ "positionType": {
+ "description": "Popup window position either centered or at specific coordinate.",
+ "enum": [
+ "CENTER",
+ "COORDINATES"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "showAddressBar": {
+ "description": "Whether to display the browser address bar.",
+ "type": "boolean"
+ },
+ "showMenuBar": {
+ "description": "Whether to display the browser menu bar.",
+ "type": "boolean"
+ },
+ "showScrollBar": {
+ "description": "Whether to display the browser scroll bar.",
+ "type": "boolean"
+ },
+ "showStatusBar": {
+ "description": "Whether to display the browser status bar.",
+ "type": "boolean"
+ },
+ "showToolBar": {
+ "description": "Whether to display the browser tool bar.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Title of popup window.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCode": {
+ "description": "Contains information about a postal code that can be targeted by ads.",
+ "id": "PostalCode",
+ "properties": {
+ "code": {
+ "description": "Postal code. This is equivalent to the id field.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the country to which this postal code belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this postal code belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this postal code.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodesListResponse": {
+ "description": "Postal Code List Response",
+ "id": "PostalCodesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
+ "type": "string"
},
- "RegionsListResponse": {
- "description": "Region List Response",
- "id": "RegionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
- "type": "string"
- },
- "regions": {
- "description": "Region collection.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "postalCodes": {
+ "description": "Postal code collection.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Pricing": {
+ "description": "Pricing Information",
+ "id": "Pricing",
+ "properties": {
+ "capCostType": {
+ "description": "Cap cost type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flights": {
+ "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
+ "items": {
+ "$ref": "Flight"
+ },
+ "type": "array"
+ },
+ "groupType": {
+ "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
+ "enum": [
+ "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
+ "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "pricingType": {
+ "description": "Pricing type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedule": {
+ "description": "Pricing Schedule",
+ "id": "PricingSchedule",
+ "properties": {
+ "capCostOption": {
+ "description": "Placement cap cost option.",
+ "enum": [
+ "CAP_COST_NONE",
+ "CAP_COST_MONTHLY",
+ "CAP_COST_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "disregardOverdelivery": {
+ "description": "Whether cap costs are ignored by ad serving.",
+ "type": "boolean"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flighted": {
+ "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.",
+ "type": "boolean"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingPeriods": {
+ "description": "Pricing periods for this placement.",
+ "items": {
+ "$ref": "PricingSchedulePricingPeriod"
+ },
+ "type": "array"
+ },
+ "pricingType": {
+ "description": "Placement pricing type. This field is required on insertion.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "testingStartDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedulePricingPeriod": {
+ "description": "Pricing Period",
+ "id": "PricingSchedulePricingPeriod",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "pricingComment": {
+ "description": "Comments for this pricing period.",
+ "type": "string"
+ },
+ "rateOrCostNanos": {
+ "description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Project": {
+ "description": "Contains properties of a Planning project.",
+ "id": "Project",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "audienceAgeGroup": {
+ "description": "Audience age group of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_AGE_18_24",
+ "PLANNING_AUDIENCE_AGE_25_34",
+ "PLANNING_AUDIENCE_AGE_35_44",
+ "PLANNING_AUDIENCE_AGE_45_54",
+ "PLANNING_AUDIENCE_AGE_55_64",
+ "PLANNING_AUDIENCE_AGE_65_OR_MORE",
+ "PLANNING_AUDIENCE_AGE_UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "audienceGender": {
+ "description": "Audience gender of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_GENDER_MALE",
+ "PLANNING_AUDIENCE_GENDER_FEMALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "budget": {
+ "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientBillingCode": {
+ "description": "Client billing code of this project.",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the project client.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this project. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this project."
+ },
+ "name": {
+ "description": "Name of this project.",
+ "type": "string"
+ },
+ "overview": {
+ "description": "Overview of this project.",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetClicks": {
+ "description": "Number of clicks that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetConversions": {
+ "description": "Number of conversions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpaNanos": {
+ "description": "CPA that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpcNanos": {
+ "description": "CPC that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmActiveViewNanos": {
+ "description": "vCPM from Active View that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmNanos": {
+ "description": "CPM that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetImpressions": {
+ "description": "Number of impressions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectsListResponse": {
+ "description": "Project List Response",
+ "id": "ProjectsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "RemarketingList": {
- "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
- "id": "RemarketingList",
- "properties": {
- "accountId": {
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this remarketing list is active.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "description": {
- "description": "Remarketing list description.",
- "type": "string"
- },
- "id": {
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
- "type": "string"
- },
- "lifeSpan": {
- "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "listPopulationRule": {
- "$ref": "ListPopulationRule",
- "description": "Rule used to populate the remarketing list with users."
- },
- "listSize": {
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "listSource": {
- "description": "Product from which this remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_OTHER",
- "REMARKETING_LIST_SOURCE_ADX",
- "REMARKETING_LIST_SOURCE_DFP",
- "REMARKETING_LIST_SOURCE_XFP",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_YOUTUBE",
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_GPLUS",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "projects": {
+ "description": "Project collection.",
+ "items": {
+ "$ref": "Project"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
+ "id": "ReachReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "reachByFrequencyMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Recipient": {
+ "description": "Represents a recipient.",
+ "id": "Recipient",
+ "properties": {
+ "deliveryType": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The delivery type for the recipient.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The email address of the recipient.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#recipient.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Region": {
+ "description": "Contains information about a region that can be targeted by ads.",
+ "id": "Region",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this region.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionsListResponse": {
+ "description": "Region List Response",
+ "id": "RegionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
+ "type": "string"
},
- "RemarketingListShare": {
- "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
- "id": "RemarketingListShare",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
- "type": "string"
- },
- "remarketingListId": {
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "sharedAccountIds": {
- "description": "Accounts that the remarketing list is shared with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "sharedAdvertiserIds": {
- "description": "Advertisers that the remarketing list is shared with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "regions": {
+ "description": "Region collection.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingList": {
+ "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
+ "id": "RemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "description": {
+ "description": "Remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listPopulationRule": {
+ "$ref": "ListPopulationRule",
+ "description": "Rule used to populate the remarketing list with users."
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListShare": {
+ "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
+ "id": "RemarketingListShare",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sharedAccountIds": {
+ "description": "Accounts that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
},
- "RemarketingListsListResponse": {
- "description": "Remarketing list response",
- "id": "RemarketingListsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "remarketingLists": {
- "description": "Remarketing list collection.",
- "items": {
- "$ref": "RemarketingList"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Report": {
- "description": "Represents a Report resource.",
- "id": "Report",
- "properties": {
- "accountId": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "type": "string"
- },
- "criteria": {
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "crossDimensionReachCriteria": {
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "description": "The dimension option.",
- "enum": [
- "ADVERTISER",
- "CAMPAIGN",
- "SITE_BY_ADVERTISER",
- "SITE_BY_CAMPAIGN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "overlapMetricNames": {
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pivoted": {
- "description": "Whether the report is pivoted or not. Defaults to true.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "delivery": {
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "description": "Whether the report should be emailed to the report owner.",
- "type": "boolean"
- },
- "emailOwnerDeliveryType": {
- "description": "The type of delivery for the owner to receive, if enabled.",
- "enum": [
- "LINK",
- "ATTACHMENT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "message": {
- "description": "The message to be sent with each email.",
- "type": "string"
- },
- "recipients": {
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "fileName": {
- "description": "The filename used when generating report files for this report.",
- "type": "string"
- },
- "floodlightCriteria": {
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reportProperties": {
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "description": "Include conversions that have no cookie, but do have an exposure path.",
- "type": "boolean"
- },
- "includeUnattributedCookieConversions": {
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
- "type": "boolean"
- },
- "includeUnattributedIPConversions": {
- "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
- "type": "boolean"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "format": {
- "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "type": "string"
- },
- "lastModifiedTime": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "type": "string"
- },
- "name": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The name of the report.",
- "type": "string"
- },
- "ownerProfileId": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "type": "string"
- },
- "pathToConversionCriteria": {
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "conversionDimensions": {
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "customFloodlightVariables": {
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "customRichMediaEvents": {
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "perInteractionDimensions": {
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "reportProperties": {
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "impressionsLookbackWindow": {
- "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "includeAttributedIPConversions": {
- "description": "Deprecated: has no effect.",
- "type": "boolean"
- },
- "includeUnattributedCookieConversions": {
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
- "type": "boolean"
- },
- "includeUnattributedIPConversions": {
- "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
- "type": "boolean"
- },
- "maximumClickInteractions": {
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32",
- "type": "integer"
- },
- "maximumImpressionInteractions": {
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32",
- "type": "integer"
- },
- "maximumInteractionGap": {
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "pivotOnInteractionPath": {
- "description": "Enable pivoting on interaction path.",
- "type": "boolean"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "reachCriteria": {
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "enableAllDimensionCombinations": {
- "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
- "type": "boolean"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reachByFrequencyMetricNames": {
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "schedule": {
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "type": "boolean"
- },
- "every": {
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32",
- "type": "integer"
- },
- "expirationDate": {
- "format": "date",
- "type": "string"
- },
- "repeats": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ",
- "type": "string"
- },
- "repeatsOnWeekDays": {
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "enum": [
- "SUNDAY",
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "runsOnDayOfMonth": {
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
- "enum": [
- "DAY_OF_MONTH",
- "WEEK_OF_MONTH"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
- },
- "type": "object"
- },
- "subAccountId": {
- "description": "The subaccount ID to which this report belongs if applicable.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The type of the report.",
- "enum": [
- "STANDARD",
- "REACH",
- "PATH_TO_CONVERSION",
- "CROSS_DIMENSION_REACH",
- "FLOODLIGHT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "id": "ReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "pivotedActivityMetrics": {
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "sharedAdvertiserIds": {
+ "description": "Advertisers that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListsListResponse": {
+ "description": "Remarketing list response",
+ "id": "RemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "ReportList": {
- "description": "Represents the list of reports.",
- "id": "ReportList",
- "properties": {
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "items": {
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "remarketingLists": {
+ "description": "Remarketing list collection.",
+ "items": {
+ "$ref": "RemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "Represents a Report resource.",
+ "id": "Report",
+ "properties": {
+ "accountId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The account ID to which this report belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "criteria": {
+ "description": "The report criteria for a report of type \"STANDARD\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
},
- "type": "object"
- },
- "ReportsConfiguration": {
- "description": "Reporting Configuration",
- "id": "ReportsConfiguration",
- "properties": {
- "exposureToConversionEnabled": {
- "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
- "type": "boolean"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Default lookback windows for new advertisers in this account."
- },
- "reportGenerationTimeZoneId": {
- "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
- "format": "int64",
- "type": "string"
- }
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
},
- "type": "object"
- },
- "RichMediaExitOverride": {
- "description": "Rich Media Exit Override.",
- "id": "RichMediaExitOverride",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
- },
- "enabled": {
- "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.",
- "type": "boolean"
- },
- "exitId": {
- "description": "ID for the override to refer to a specific exit in the creative.",
- "format": "int64",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which this report should be run."
},
- "type": "object"
- },
- "Rule": {
- "description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
- "id": "Rule",
- "properties": {
- "assetId": {
- "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "A user-friendly name for this rule. This is a required field.",
- "type": "string"
- },
- "targetingTemplateId": {
- "description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
- "format": "int64",
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "Site": {
- "description": "Contains properties of a site.",
- "id": "Site",
- "properties": {
- "accountId": {
- "description": "Account ID of this site. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "approved": {
- "description": "Whether this site is approved.",
- "type": "boolean"
- },
- "directorySiteId": {
- "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this site. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
- },
- "keyName": {
- "description": "Key name of this site. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.",
- "type": "string"
- },
- "siteContacts": {
- "description": "Site contacts.",
- "items": {
- "$ref": "SiteContact"
- },
- "type": "array"
- },
- "siteSettings": {
- "$ref": "SiteSettings",
- "description": "Site-wide settings."
- },
- "subaccountId": {
- "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "videoSettings": {
- "$ref": "SiteVideoSettings",
- "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
- }
+ "dimensions": {
+ "description": "The list of standard dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteCompanionSetting": {
- "description": "Companion Settings",
- "id": "SiteCompanionSetting",
- "properties": {
- "companionsDisabled": {
- "description": "Whether companions are disabled for this site template.",
- "type": "boolean"
- },
- "enabledSizes": {
- "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "imageOnly": {
- "description": "Whether to serve only static images as companions.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "crossDimensionReachCriteria": {
+ "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
+ "properties": {
+ "breakdown": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteContact": {
- "description": "Site Contact",
- "id": "SiteContact",
- "properties": {
- "address": {
- "description": "Address of this site contact.",
- "type": "string"
- },
- "contactType": {
- "description": "Site contact type.",
- "enum": [
- "SALES_PERSON",
- "TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "email": {
- "description": "Email address of this site contact. This is a required field.",
- "type": "string"
- },
- "firstName": {
- "description": "First name of this site contact.",
- "type": "string"
- },
- "id": {
- "description": "ID of this site contact. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "lastName": {
- "description": "Last name of this site contact.",
- "type": "string"
- },
- "phone": {
- "description": "Primary phone number of this site contact.",
- "type": "string"
- },
- "title": {
- "description": "Title or designation of this site contact.",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "SiteSettings": {
- "description": "Site Settings",
- "id": "SiteSettings",
- "properties": {
- "activeViewOptOut": {
- "description": "Whether active view creatives are disabled for this site.",
- "type": "boolean"
- },
- "adBlockingOptOut": {
- "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.",
- "type": "boolean"
- },
- "disableNewCookie": {
- "description": "Whether new cookies are disabled for this site.",
- "type": "boolean"
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "videoActiveViewOptOutTemplate": {
- "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
- "type": "boolean"
- },
- "vpaidAdapterChoiceTemplate": {
- "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
- "enum": [
- "DEFAULT",
- "FLASH",
- "HTML5",
- "BOTH"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "dimension": {
+ "description": "The dimension option.",
+ "enum": [
+ "ADVERTISER",
+ "CAMPAIGN",
+ "SITE_BY_ADVERTISER",
+ "SITE_BY_CAMPAIGN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
- },
- "SiteSkippableSetting": {
- "description": "Skippable Settings",
- "id": "SiteSkippableSetting",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true."
- },
- "skippable": {
- "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.",
- "type": "boolean"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteTranscodeSetting": {
- "description": "Transcode Settings",
- "id": "SiteTranscodeSetting",
- "properties": {
- "enabledVideoFormats": {
- "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteVideoSettings": {
- "description": "Video Settings",
- "id": "SiteVideoSettings",
- "properties": {
- "companionSettings": {
- "$ref": "SiteCompanionSetting",
- "description": "Settings for the companion creatives of video creatives served to this site."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".",
- "type": "string"
- },
- "orientation": {
- "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
- "enum": [
- "ANY",
- "LANDSCAPE",
- "PORTRAIT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "skippableSettings": {
- "$ref": "SiteSkippableSetting",
- "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site."
- },
- "transcodeSettings": {
- "$ref": "SiteTranscodeSetting",
- "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site."
- }
+ "overlapMetricNames": {
+ "description": "The list of names of overlap metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SitesListResponse": {
- "description": "Site List Response",
- "id": "SitesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "sites": {
- "description": "Site collection.",
- "items": {
- "$ref": "Site"
- },
- "type": "array"
- }
+ "pivoted": {
+ "description": "Whether the report is pivoted or not. Defaults to true.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "delivery": {
+ "description": "The report's email delivery settings.",
+ "properties": {
+ "emailOwner": {
+ "description": "Whether the report should be emailed to the report owner.",
+ "type": "boolean"
},
- "type": "object"
- },
- "Size": {
- "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
- "id": "Size",
- "properties": {
- "height": {
- "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "iab": {
- "description": "IAB standard size. This is a read-only, auto-generated field.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this size. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
- "type": "string"
- },
- "width": {
- "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
- "format": "int32",
- "type": "integer"
- }
+ "emailOwnerDeliveryType": {
+ "description": "The type of delivery for the owner to receive, if enabled.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
- },
- "SizesListResponse": {
- "description": "Size List Response",
- "id": "SizesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
- "type": "string"
- },
- "sizes": {
- "description": "Size collection.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- }
+ "message": {
+ "description": "The message to be sent with each email.",
+ "type": "string"
},
- "type": "object"
- },
- "SkippableSetting": {
- "description": "Skippable Settings",
- "id": "SkippableSetting",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
- },
- "skippable": {
- "description": "Whether the user can skip creatives served to this placement.",
- "type": "boolean"
- }
+ "recipients": {
+ "description": "The list of recipients to which to email the report.",
+ "items": {
+ "$ref": "Recipient"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename used when generating report files for this report.",
+ "type": "string"
+ },
+ "floodlightCriteria": {
+ "description": "The report criteria for a report of type \"FLOODLIGHT\".",
+ "properties": {
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SortedDimension": {
- "description": "Represents a sorted dimension.",
- "id": "SortedDimension",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "type": "string"
- },
- "name": {
- "description": "The name of the dimension.",
- "type": "string"
- },
- "sortOrder": {
- "description": "An optional sort order for the dimension column.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "Subaccount": {
- "description": "Contains properties of a Campaign Manager subaccount.",
- "id": "Subaccount",
- "properties": {
- "accountId": {
- "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "availablePermissionIds": {
- "description": "IDs of the available user role permissions for this subaccount.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this subaccount. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.",
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SubaccountsListResponse": {
- "description": "Subaccount List Response",
- "id": "SubaccountsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "subaccounts": {
- "description": "Subaccount collection.",
- "items": {
- "$ref": "Subaccount"
- },
- "type": "array"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TagData": {
- "description": "Placement Tag Data",
- "id": "TagData",
- "properties": {
- "adId": {
- "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
- "format": "int64",
- "type": "string"
- },
- "clickTag": {
- "description": "Tag string to record a click.",
- "type": "string"
- },
- "creativeId": {
- "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
- "format": "int64",
- "type": "string"
- },
- "format": {
- "description": "TagData tag format of this tag.",
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "impressionTag": {
- "description": "Tag string for serving an ad.",
- "type": "string"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "TagSetting": {
- "description": "Tag Settings",
- "id": "TagSetting",
- "properties": {
- "additionalKeyValues": {
- "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.",
- "type": "string"
- },
- "includeClickThroughUrls": {
- "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.",
- "type": "boolean"
- },
- "includeClickTracking": {
- "description": "Whether click-tracking string should be included in the tags.",
- "type": "boolean"
- },
- "keywordOption": {
- "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
- "enum": [
- "PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
- "IGNORE",
- "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TagSettings": {
- "description": "Dynamic and Image Tag Settings.",
- "id": "TagSettings",
- "properties": {
- "dynamicTagEnabled": {
- "description": "Whether dynamic floodlight tags are enabled.",
- "type": "boolean"
- },
- "imageTagEnabled": {
- "description": "Whether image tags are enabled.",
- "type": "boolean"
- }
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "includeAttributedIPConversions": {
+ "description": "Include conversions that have no cookie, but do have an exposure path.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "format": {
+ "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The unique ID identifying this report resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#report.",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The name of the report.",
+ "type": "string"
+ },
+ "ownerProfileId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The user profile id of the owner of this report.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pathToConversionCriteria": {
+ "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetWindow": {
- "description": "Target Window.",
- "id": "TargetWindow",
- "properties": {
- "customHtml": {
- "description": "User-entered value.",
- "type": "string"
- },
- "targetWindowOption": {
- "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
- "enum": [
- "NEW_WINDOW",
- "CURRENT_WINDOW",
- "CUSTOM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "conversionDimensions": {
+ "description": "The list of conversion dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetableRemarketingList": {
- "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
- "id": "TargetableRemarketingList",
- "properties": {
- "accountId": {
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this targetable remarketing list is active.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser."
- },
- "description": {
- "description": "Targetable remarketing list description.",
- "type": "string"
- },
- "id": {
- "description": "Targetable remarketing list ID.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
- "type": "string"
- },
- "lifeSpan": {
- "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
- "format": "int64",
- "type": "string"
- },
- "listSize": {
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "listSource": {
- "description": "Product from which this targetable remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_OTHER",
- "REMARKETING_LIST_SOURCE_ADX",
- "REMARKETING_LIST_SOURCE_DFP",
- "REMARKETING_LIST_SOURCE_XFP",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_YOUTUBE",
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_GPLUS",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- }
+ "customFloodlightVariables": {
+ "description": "The list of custom floodlight variables the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetableRemarketingListsListResponse": {
- "description": "Targetable remarketing list response",
- "id": "TargetableRemarketingListsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "targetableRemarketingLists": {
- "description": "Targetable remarketing list collection.",
- "items": {
- "$ref": "TargetableRemarketingList"
- },
- "type": "array"
- }
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetingTemplate": {
- "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.",
- "id": "TargetingTemplate",
- "properties": {
- "accountId": {
- "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting criteria."
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting criteria."
- },
- "id": {
- "description": "ID of this targeting template. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting criteria."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
- "type": "string"
- },
- "languageTargeting": {
- "$ref": "LanguageTargeting",
- "description": "Language targeting criteria."
- },
- "listTargetingExpression": {
- "$ref": "ListTargetingExpression",
- "description": "Remarketing list targeting criteria."
- },
- "name": {
- "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting criteria."
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "TargetingTemplatesListResponse": {
- "description": "Targeting Template List Response",
- "id": "TargetingTemplatesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "targetingTemplates": {
- "description": "Targeting template collection.",
- "items": {
- "$ref": "TargetingTemplate"
- },
- "type": "array"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "TechnologyTargeting": {
- "description": "Technology Targeting.",
- "id": "TechnologyTargeting",
- "properties": {
- "browsers": {
- "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Browser"
- },
- "type": "array"
- },
- "connectionTypes": {
- "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "ConnectionType"
- },
- "type": "array"
- },
- "mobileCarriers": {
- "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
- "items": {
- "$ref": "MobileCarrier"
- },
- "type": "array"
- },
- "operatingSystemVersions": {
- "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
- "items": {
- "$ref": "OperatingSystemVersion"
- },
- "type": "array"
- },
- "operatingSystems": {
- "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
- "items": {
- "$ref": "OperatingSystem"
- },
- "type": "array"
- },
- "platformTypes": {
- "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "PlatformType"
- },
- "type": "array"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ThirdPartyAuthenticationToken": {
- "description": "Third Party Authentication Token",
- "id": "ThirdPartyAuthenticationToken",
- "properties": {
- "name": {
- "description": "Name of the third-party authentication token.",
- "type": "string"
- },
- "value": {
- "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
- "type": "string"
- }
+ "perInteractionDimensions": {
+ "description": "The list of per interaction dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ThirdPartyTrackingUrl": {
- "description": "Third-party Tracking URL.",
- "id": "ThirdPartyTrackingUrl",
- "properties": {
- "thirdPartyUrlType": {
- "description": "Third-party URL type for in-stream video and in-stream audio creatives.",
- "enum": [
- "IMPRESSION",
- "CLICK_TRACKING",
- "VIDEO_START",
- "VIDEO_FIRST_QUARTILE",
- "VIDEO_MIDPOINT",
- "VIDEO_THIRD_QUARTILE",
- "VIDEO_COMPLETE",
- "VIDEO_MUTE",
- "VIDEO_PAUSE",
- "VIDEO_REWIND",
- "VIDEO_FULLSCREEN",
- "VIDEO_STOP",
- "VIDEO_CUSTOM",
- "SURVEY",
- "RICH_MEDIA_IMPRESSION",
- "RICH_MEDIA_RM_IMPRESSION",
- "RICH_MEDIA_BACKUP_IMPRESSION",
- "VIDEO_SKIP",
- "VIDEO_PROGRESS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "url": {
- "description": "URL for the specified third-party URL type.",
- "type": "string"
- }
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "clicksLookbackWindow": {
+ "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionsLookbackWindow": {
+ "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "includeAttributedIPConversions": {
+ "description": "Deprecated: has no effect.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ },
+ "maximumClickInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumImpressionInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumInteractionGap": {
+ "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pivotOnInteractionPath": {
+ "description": "Enable pivoting on interaction path.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "reachCriteria": {
+ "description": "The report criteria for a report of type \"REACH\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
},
- "type": "object"
- },
- "TranscodeSetting": {
- "description": "Transcode Settings",
- "id": "TranscodeSetting",
- "properties": {
- "enabledVideoFormats": {
- "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
- "type": "string"
- }
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
},
- "type": "object"
- },
- "UniversalAdId": {
- "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
- "id": "UniversalAdId",
- "properties": {
- "registry": {
- "description": "Registry used for the Ad ID value.",
- "enum": [
- "OTHER",
- "AD_ID.ORG",
- "CLEARCAST",
- "DCM"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "UserDefinedVariableConfiguration": {
- "description": "User Defined Variable configuration.",
- "id": "UserDefinedVariableConfiguration",
- "properties": {
- "dataType": {
- "description": "Data type for the variable. This is a required field.",
- "enum": [
- "STRING",
- "NUMBER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "reportName": {
- "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".",
- "type": "string"
- },
- "variableType": {
- "description": "Variable name in the tag. This is a required field.",
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserProfile": {
- "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
- "id": "UserProfile",
- "properties": {
- "accountId": {
- "description": "The account ID to which this profile belongs.",
- "format": "int64",
- "type": "string"
- },
- "accountName": {
- "description": "The account name this profile belongs to.",
- "type": "string"
- },
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".",
- "type": "string"
- },
- "profileId": {
- "description": "The unique ID of the user profile.",
- "format": "int64",
- "type": "string"
- },
- "subAccountId": {
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64",
- "type": "string"
- },
- "subAccountName": {
- "description": "The sub account name this profile belongs to if applicable.",
- "type": "string"
- },
- "userName": {
- "description": "The user name.",
- "type": "string"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserProfileList": {
- "description": "Represents the list of user profiles.",
- "id": "UserProfileList",
- "properties": {
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "items": {
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
- "type": "string"
- }
+ "enableAllDimensionCombinations": {
+ "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
+ "type": "boolean"
},
- "type": "object"
- },
- "UserRole": {
- "description": "Contains properties of auser role, which is used to manage user access.",
- "id": "UserRole",
- "properties": {
- "accountId": {
- "description": "Account ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "defaultUserRole": {
- "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this user role. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
- "type": "string"
- },
- "parentUserRoleId": {
- "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "permissions": {
- "description": "List of permissions associated with this user role.",
- "items": {
- "$ref": "UserRolePermission"
- },
- "type": "array"
- },
- "subaccountId": {
- "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserRolePermission": {
- "description": "Contains properties of a user role permission.",
- "id": "UserRolePermission",
- "properties": {
- "availability": {
- "description": "Levels of availability for a user role permission.",
- "enum": [
- "NOT_AVAILABLE_BY_DEFAULT",
- "ACCOUNT_BY_DEFAULT",
- "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
- "ACCOUNT_ALWAYS",
- "SUBACCOUNT_AND_ACCOUNT_ALWAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this user role permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role permission.",
- "type": "string"
- },
- "permissionGroupId": {
- "description": "ID of the permission group that this user role permission belongs to.",
- "format": "int64",
- "type": "string"
- }
+ "reachByFrequencyMetricNames": {
+ "description": "The list of names of Reach By Frequency metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schedule": {
+ "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
+ "properties": {
+ "active": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "Whether the schedule is active or not. Must be set to either true or false.",
+ "type": "boolean"
},
- "type": "object"
- },
- "UserRolePermissionGroup": {
- "description": "Represents a grouping of related user role permissions.",
- "id": "UserRolePermissionGroup",
- "properties": {
- "id": {
- "description": "ID of this user role permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role permission group.",
- "type": "string"
- }
+ "every": {
+ "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
+ "format": "int32",
+ "type": "integer"
},
- "type": "object"
- },
- "UserRolePermissionGroupsListResponse": {
- "description": "User Role Permission Group List Response",
- "id": "UserRolePermissionGroupsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
- "type": "string"
- },
- "userRolePermissionGroups": {
- "description": "User role permission group collection.",
- "items": {
- "$ref": "UserRolePermissionGroup"
- },
- "type": "array"
- }
+ "expirationDate": {
+ "format": "date",
+ "type": "string"
},
- "type": "object"
- },
- "UserRolePermissionsListResponse": {
- "description": "User Role Permission List Response",
- "id": "UserRolePermissionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
- "type": "string"
- },
- "userRolePermissions": {
- "description": "User role permission collection.",
- "items": {
- "$ref": "UserRolePermission"
- },
- "type": "array"
- }
+ "repeats": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ",
+ "type": "string"
},
- "type": "object"
- },
- "UserRolesListResponse": {
- "description": "User Role List Response",
- "id": "UserRolesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "userRoles": {
- "description": "User role collection.",
- "items": {
- "$ref": "UserRole"
- },
- "type": "array"
- }
+ "repeatsOnWeekDays": {
+ "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
+ "items": {
+ "enum": [
+ "SUNDAY",
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "VideoFormat": {
- "description": "Contains information about supported video formats.",
- "id": "VideoFormat",
- "properties": {
- "fileType": {
- "description": "File type of the video format.",
- "enum": [
- "FLV",
- "THREEGPP",
- "MP4",
- "WEBM",
- "M3U8"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of the video format.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
- "type": "string"
- },
- "resolution": {
- "$ref": "Size",
- "description": "The resolution of this video format."
- },
- "targetBitRate": {
- "description": "The target bit rate of this video format.",
- "format": "int32",
- "type": "integer"
- }
+ "runsOnDayOfMonth": {
+ "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
+ "enum": [
+ "DAY_OF_MONTH",
+ "WEEK_OF_MONTH"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "subAccountId": {
+ "description": "The subaccount ID to which this report belongs if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The type of the report.",
+ "enum": [
+ "STANDARD",
+ "REACH",
+ "PATH_TO_CONVERSION",
+ "CROSS_DIMENSION_REACH",
+ "FLOODLIGHT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
+ "id": "ReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportList": {
+ "description": "Represents the list of reports.",
+ "id": "ReportList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The reports returned in this response.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#reportList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportsConfiguration": {
+ "description": "Reporting Configuration",
+ "id": "ReportsConfiguration",
+ "properties": {
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Default lookback windows for new advertisers in this account."
+ },
+ "reportGenerationTimeZoneId": {
+ "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RichMediaExitOverride": {
+ "description": "Rich Media Exit Override.",
+ "id": "RichMediaExitOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
+ },
+ "enabled": {
+ "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.",
+ "type": "boolean"
+ },
+ "exitId": {
+ "description": "ID for the override to refer to a specific exit in the creative.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Rule": {
+ "description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "Rule",
+ "properties": {
+ "assetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "A user-friendly name for this rule. This is a required field.",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Site": {
+ "description": "Contains properties of a site.",
+ "id": "Site",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approved": {
+ "description": "Whether this site is approved.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this site. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.",
+ "type": "string"
+ },
+ "siteContacts": {
+ "description": "Site contacts.",
+ "items": {
+ "$ref": "SiteContact"
+ },
+ "type": "array"
+ },
+ "siteSettings": {
+ "$ref": "SiteSettings",
+ "description": "Site-wide settings."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "videoSettings": {
+ "$ref": "SiteVideoSettings",
+ "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
+ }
+ },
+ "type": "object"
+ },
+ "SiteCompanionSetting": {
+ "description": "Companion Settings",
+ "id": "SiteCompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this site template.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteContact": {
+ "description": "Site Contact",
+ "id": "SiteContact",
+ "properties": {
+ "address": {
+ "description": "Address of this site contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Site contact type.",
+ "enum": [
+ "SALES_PERSON",
+ "TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "description": "Email address of this site contact. This is a required field.",
+ "type": "string"
+ },
+ "firstName": {
+ "description": "First name of this site contact.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this site contact. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastName": {
+ "description": "Last name of this site contact.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "Primary phone number of this site contact.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title or designation of this site contact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSettings": {
+ "description": "Site Settings",
+ "id": "SiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether active view creatives are disabled for this site.",
+ "type": "boolean"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.",
+ "type": "boolean"
+ },
+ "disableNewCookie": {
+ "description": "Whether new cookies are disabled for this site.",
+ "type": "boolean"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "videoActiveViewOptOutTemplate": {
+ "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
+ "type": "boolean"
+ },
+ "vpaidAdapterChoiceTemplate": {
+ "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SiteSkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SiteTranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "SiteTranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteVideoSettings": {
+ "description": "Video Settings",
+ "id": "SiteVideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "SiteCompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this site."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".",
+ "type": "string"
+ },
+ "orientation": {
+ "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SiteSkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site."
+ },
+ "transcodeSettings": {
+ "$ref": "SiteTranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site."
+ }
+ },
+ "type": "object"
+ },
+ "SitesListResponse": {
+ "description": "Site List Response",
+ "id": "SitesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "VideoFormatsListResponse": {
- "description": "Video Format List Response",
- "id": "VideoFormatsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".",
- "type": "string"
- },
- "videoFormats": {
- "description": "Video format collection.",
- "items": {
- "$ref": "VideoFormat"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "sites": {
+ "description": "Site collection.",
+ "items": {
+ "$ref": "Site"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Size": {
+ "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
+ "id": "Size",
+ "properties": {
+ "height": {
+ "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "iab": {
+ "description": "IAB standard size. This is a read-only, auto-generated field.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this size. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SizesListResponse": {
+ "description": "Size List Response",
+ "id": "SizesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
+ "type": "string"
},
- "VideoOffset": {
- "description": "Video Offset",
- "id": "VideoOffset",
- "properties": {
- "offsetPercentage": {
- "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "offsetSeconds": {
- "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
+ "sizes": {
+ "description": "Size collection.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this placement.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SortedDimension": {
+ "description": "Represents a sorted dimension.",
+ "id": "SortedDimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "An optional sort order for the dimension column.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Subaccount": {
+ "description": "Contains properties of a Campaign Manager subaccount.",
+ "id": "Subaccount",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "availablePermissionIds": {
+ "description": "IDs of the available user role permissions for this subaccount.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
},
- "VideoSettings": {
- "description": "Video Settings",
- "id": "VideoSettings",
- "properties": {
- "companionSettings": {
- "$ref": "CompanionSetting",
- "description": "Settings for the companion creatives of video creatives served to this placement."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
- "type": "string"
- },
- "orientation": {
- "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
- "enum": [
- "ANY",
- "LANDSCAPE",
- "PORTRAIT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "skippableSettings": {
- "$ref": "SkippableSetting",
- "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden."
- },
- "transcodeSettings": {
- "$ref": "TranscodeSetting",
- "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
- }
- },
- "type": "object"
+ "id": {
+ "description": "ID of this subaccount. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubaccountsListResponse": {
+ "description": "Subaccount List Response",
+ "id": "SubaccountsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "subaccounts": {
+ "description": "Subaccount collection.",
+ "items": {
+ "$ref": "Subaccount"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagData": {
+ "description": "Placement Tag Data",
+ "id": "TagData",
+ "properties": {
+ "adId": {
+ "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickTag": {
+ "description": "Tag string to record a click.",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "format": {
+ "description": "TagData tag format of this tag.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "impressionTag": {
+ "description": "Tag string for serving an ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSetting": {
+ "description": "Tag Settings",
+ "id": "TagSetting",
+ "properties": {
+ "additionalKeyValues": {
+ "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.",
+ "type": "string"
+ },
+ "includeClickThroughUrls": {
+ "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.",
+ "type": "boolean"
+ },
+ "includeClickTracking": {
+ "description": "Whether click-tracking string should be included in the tags.",
+ "type": "boolean"
+ },
+ "keywordOption": {
+ "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
+ "enum": [
+ "PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
+ "IGNORE",
+ "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSettings": {
+ "description": "Dynamic and Image Tag Settings.",
+ "id": "TagSettings",
+ "properties": {
+ "dynamicTagEnabled": {
+ "description": "Whether dynamic floodlight tags are enabled.",
+ "type": "boolean"
+ },
+ "imageTagEnabled": {
+ "description": "Whether image tags are enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "TargetWindow": {
+ "description": "Target Window.",
+ "id": "TargetWindow",
+ "properties": {
+ "customHtml": {
+ "description": "User-entered value.",
+ "type": "string"
+ },
+ "targetWindowOption": {
+ "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
+ "enum": [
+ "NEW_WINDOW",
+ "CURRENT_WINDOW",
+ "CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetableRemarketingList": {
+ "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
+ "id": "TargetableRemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this targetable remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser."
+ },
+ "description": {
+ "description": "Targetable remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Targetable remarketing list ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this targetable remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "dfareporting/v3.3/",
- "title": "Campaign Manager 360 API",
- "version": "v3.3"
+ "TargetableRemarketingListsListResponse": {
+ "description": "Targetable remarketing list response",
+ "id": "TargetableRemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetableRemarketingLists": {
+ "description": "Targetable remarketing list collection.",
+ "items": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplate": {
+ "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.",
+ "id": "TargetingTemplate",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting criteria."
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting criteria."
+ },
+ "id": {
+ "description": "ID of this targeting template. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting criteria."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting criteria."
+ },
+ "listTargetingExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting criteria."
+ },
+ "name": {
+ "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting criteria."
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplatesListResponse": {
+ "description": "Targeting Template List Response",
+ "id": "TargetingTemplatesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetingTemplates": {
+ "description": "Targeting template collection.",
+ "items": {
+ "$ref": "TargetingTemplate"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TechnologyTargeting": {
+ "description": "Technology Targeting.",
+ "id": "TechnologyTargeting",
+ "properties": {
+ "browsers": {
+ "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "connectionTypes": {
+ "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ },
+ "operatingSystems": {
+ "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ },
+ "platformTypes": {
+ "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyAuthenticationToken": {
+ "description": "Third Party Authentication Token",
+ "id": "ThirdPartyAuthenticationToken",
+ "properties": {
+ "name": {
+ "description": "Name of the third-party authentication token.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyTrackingUrl": {
+ "description": "Third-party Tracking URL.",
+ "id": "ThirdPartyTrackingUrl",
+ "properties": {
+ "thirdPartyUrlType": {
+ "description": "Third-party URL type for in-stream video and in-stream audio creatives.",
+ "enum": [
+ "IMPRESSION",
+ "CLICK_TRACKING",
+ "VIDEO_START",
+ "VIDEO_FIRST_QUARTILE",
+ "VIDEO_MIDPOINT",
+ "VIDEO_THIRD_QUARTILE",
+ "VIDEO_COMPLETE",
+ "VIDEO_MUTE",
+ "VIDEO_PAUSE",
+ "VIDEO_REWIND",
+ "VIDEO_FULLSCREEN",
+ "VIDEO_STOP",
+ "VIDEO_CUSTOM",
+ "SURVEY",
+ "RICH_MEDIA_IMPRESSION",
+ "RICH_MEDIA_RM_IMPRESSION",
+ "RICH_MEDIA_BACKUP_IMPRESSION",
+ "VIDEO_SKIP",
+ "VIDEO_PROGRESS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the specified third-party URL type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "TranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UniversalAdId": {
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
+ "id": "UniversalAdId",
+ "properties": {
+ "registry": {
+ "description": "Registry used for the Ad ID value.",
+ "enum": [
+ "OTHER",
+ "AD_ID.ORG",
+ "CLEARCAST",
+ "DCM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserDefinedVariableConfiguration": {
+ "description": "User Defined Variable configuration.",
+ "id": "UserDefinedVariableConfiguration",
+ "properties": {
+ "dataType": {
+ "description": "Data type for the variable. This is a required field.",
+ "enum": [
+ "STRING",
+ "NUMBER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "reportName": {
+ "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".",
+ "type": "string"
+ },
+ "variableType": {
+ "description": "Variable name in the tag. This is a required field.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfile": {
+ "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
+ "id": "UserProfile",
+ "properties": {
+ "accountId": {
+ "description": "The account ID to which this profile belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "accountName": {
+ "description": "The account name this profile belongs to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The unique ID of the user profile.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountId": {
+ "description": "The sub account ID this profile belongs to if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountName": {
+ "description": "The sub account name this profile belongs to if applicable.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "The user name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfileList": {
+ "description": "Represents the list of user profiles.",
+ "id": "UserProfileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The user profiles returned in this response.",
+ "items": {
+ "$ref": "UserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRole": {
+ "description": "Contains properties of auser role, which is used to manage user access.",
+ "id": "UserRole",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultUserRole": {
+ "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this user role. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
+ "type": "string"
+ },
+ "parentUserRoleId": {
+ "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "List of permissions associated with this user role.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermission": {
+ "description": "Contains properties of a user role permission.",
+ "id": "UserRolePermission",
+ "properties": {
+ "availability": {
+ "description": "Levels of availability for a user role permission.",
+ "enum": [
+ "NOT_AVAILABLE_BY_DEFAULT",
+ "ACCOUNT_BY_DEFAULT",
+ "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
+ "ACCOUNT_ALWAYS",
+ "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
+ "USER_PROFILE_ONLY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "ID of the permission group that this user role permission belongs to.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroup": {
+ "description": "Represents a grouping of related user role permissions.",
+ "id": "UserRolePermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroupsListResponse": {
+ "description": "User Role Permission Group List Response",
+ "id": "UserRolePermissionGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissionGroups": {
+ "description": "User role permission group collection.",
+ "items": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionsListResponse": {
+ "description": "User Role Permission List Response",
+ "id": "UserRolePermissionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissions": {
+ "description": "User role permission collection.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolesListResponse": {
+ "description": "User Role List Response",
+ "id": "UserRolesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "userRoles": {
+ "description": "User role collection.",
+ "items": {
+ "$ref": "UserRole"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormat": {
+ "description": "Contains information about supported video formats.",
+ "id": "VideoFormat",
+ "properties": {
+ "fileType": {
+ "description": "File type of the video format.",
+ "enum": [
+ "FLV",
+ "THREEGPP",
+ "MP4",
+ "WEBM",
+ "M3U8"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the video format.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
+ "type": "string"
+ },
+ "resolution": {
+ "$ref": "Size",
+ "description": "The resolution of this video format."
+ },
+ "targetBitRate": {
+ "description": "The target bit rate of this video format.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormatsListResponse": {
+ "description": "Video Format List Response",
+ "id": "VideoFormatsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".",
+ "type": "string"
+ },
+ "videoFormats": {
+ "description": "Video format collection.",
+ "items": {
+ "$ref": "VideoFormat"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoOffset": {
+ "description": "Video Offset",
+ "id": "VideoOffset",
+ "properties": {
+ "offsetPercentage": {
+ "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetSeconds": {
+ "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoSettings": {
+ "description": "Video Settings",
+ "id": "VideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "CompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this placement."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
+ "type": "string"
+ },
+ "orientation": {
+ "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden."
+ },
+ "transcodeSettings": {
+ "$ref": "TranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "dfareporting/v3.3/",
+ "title": "Campaign Manager 360 API",
+ "version": "v3.3"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v3.4.json b/googleapiclient/discovery_cache/documents/dfareporting.v3.4.json
index f74e2cedb89..cc0facee27e 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v3.4.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v3.4.json
@@ -1,20714 +1,20719 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/ddmconversions": {
- "description": "Manage DoubleClick Digital Marketing conversions"
- },
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- },
- "https://www.googleapis.com/auth/dfatrafficking": {
- "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
- }
- }
- }
- },
- "basePath": "/dfareporting/v3.4/",
- "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.4/",
- "batchPath": "batch",
- "canonicalName": "Dfareporting",
- "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
- "discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "dfareporting:v3.4",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
- "name": "dfareporting",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/ddmconversions": {
+ "description": "Manage DoubleClick Digital Marketing conversions"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/dfareporting": {
+ "description": "View and manage DoubleClick for Advertisers reports"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "https://www.googleapis.com/auth/dfatrafficking": {
+ "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
}
+ }
+ }
+ },
+ "basePath": "/dfareporting/v3.4/",
+ "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.4/",
+ "batchPath": "batch",
+ "canonicalName": "Dfareporting",
+ "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "dfareporting:v3.4",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
+ "name": "dfareporting",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "protocol": "rest",
- "resources": {
- "accountActiveAdSummaries": {
- "methods": {
- "get": {
- "description": "Gets the account's active ad summary by account ID.",
- "flatPath": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "httpMethod": "GET",
- "id": "dfareporting.accountActiveAdSummaries.get",
- "parameterOrder": [
- "profileId",
- "summaryAccountId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "summaryAccountId": {
- "description": "Account ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "response": {
- "$ref": "AccountActiveAdSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accountActiveAdSummaries": {
+ "methods": {
+ "get": {
+ "description": "Gets the account's active ad summary by account ID.",
+ "flatPath": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountActiveAdSummaries.get",
+ "parameterOrder": [
+ "profileId",
+ "summaryAccountId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "summaryAccountId": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountPermissionGroups": {
- "methods": {
- "get": {
- "description": "Gets one account permission group by ID.",
- "flatPath": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissionGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account permission group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "response": {
- "$ref": "AccountPermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of account permission groups.",
- "flatPath": "userprofiles/{profileId}/accountPermissionGroups",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissionGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissionGroups",
- "response": {
- "$ref": "AccountPermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "response": {
+ "$ref": "AccountActiveAdSummary"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission group by ID.",
+ "flatPath": "userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountPermissions": {
- "methods": {
- "get": {
- "description": "Gets one account permission by ID.",
- "flatPath": "userprofiles/{profileId}/accountPermissions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account permission ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissions/{id}",
- "response": {
- "$ref": "AccountPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of account permissions.",
- "flatPath": "userprofiles/{profileId}/accountPermissions",
- "httpMethod": "GET",
- "id": "dfareporting.accountPermissions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountPermissions",
- "response": {
- "$ref": "AccountPermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "response": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permission groups.",
+ "flatPath": "userprofiles/{profileId}/accountPermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accountUserProfiles": {
- "methods": {
- "get": {
- "description": "Gets one account user profile by ID.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accountUserProfiles.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new account user profile.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "POST",
- "id": "dfareporting.accountUserProfiles.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "GET",
- "id": "dfareporting.accountUserProfiles.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active user profiles.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only user profiles with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only user profiles with the specified subaccount ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "userRoleId": {
- "description": "Select only user profiles with the specified user role ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "response": {
- "$ref": "AccountUserProfilesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing account user profile. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PATCH",
- "id": "dfareporting.accountUserProfiles.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "AccountUserProfile ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing account user profile.",
- "flatPath": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PUT",
- "id": "dfareporting.accountUserProfiles.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissionGroups",
+ "response": {
+ "$ref": "AccountPermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission by ID.",
+ "flatPath": "userprofiles/{profileId}/accountPermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "accounts": {
- "methods": {
- "get": {
- "description": "Gets one account by ID.",
- "flatPath": "userprofiles/{profileId}/accounts/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.accounts.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts/{id}",
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "GET",
- "id": "dfareporting.accounts.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only accounts with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing account. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "PATCH",
- "id": "dfareporting.accounts.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Account ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing account.",
- "flatPath": "userprofiles/{profileId}/accounts",
- "httpMethod": "PUT",
- "id": "dfareporting.accounts.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissions/{id}",
+ "response": {
+ "$ref": "AccountPermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permissions.",
+ "flatPath": "userprofiles/{profileId}/accountPermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "ads": {
- "methods": {
- "get": {
- "description": "Gets one ad by ID.",
- "flatPath": "userprofiles/{profileId}/ads/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.ads.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Ad ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads/{id}",
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new ad.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "POST",
- "id": "dfareporting.ads.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "GET",
- "id": "dfareporting.ads.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active ads.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only ads with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "archived": {
- "description": "Select only archived ads.",
- "location": "query",
- "type": "boolean"
- },
- "audienceSegmentIds": {
- "description": "Select only ads with these audience segment IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "campaignIds": {
- "description": "Select only ads with these campaign IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "compatibility": {
- "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "creativeIds": {
- "description": "Select only ads with these creative IDs assigned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "creativeOptimizationConfigurationIds": {
- "description": "Select only ads with these creative optimization configuration IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "dynamicClickTracker": {
- "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only ads with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "landingPageIds": {
- "description": "Select only ads with these landing page IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "overriddenEventTagId": {
- "description": "Select only ads with this event tag override ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "placementIds": {
- "description": "Select only ads with these placement IDs assigned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "remarketingListIds": {
- "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- "location": "query",
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only ads with these size IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sslCompliant": {
- "description": "Select only ads that are SSL-compliant.",
- "location": "query",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Select only ads that require SSL.",
- "location": "query",
- "type": "boolean"
- },
- "type": {
- "description": "Select only ads with these types.",
- "enum": [
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_TRACKING",
- "AD_SERVING_BRAND_SAFE_AD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "response": {
- "$ref": "AdsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing ad. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "PATCH",
- "id": "dfareporting.ads.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Ad ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing ad.",
- "flatPath": "userprofiles/{profileId}/ads",
- "httpMethod": "PUT",
- "id": "dfareporting.ads.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/ads",
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountPermissions",
+ "response": {
+ "$ref": "AccountPermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountUserProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one account user profile by ID.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "advertiserGroups": {
- "methods": {
- "delete": {
- "description": "Deletes an existing advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.advertiserGroups.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one advertiser group by ID.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "POST",
- "id": "dfareporting.advertiserGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only advertiser groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "response": {
- "$ref": "AdvertiserGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertiserGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "AdvertiserGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing advertiser group.",
- "flatPath": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.advertiserGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserGroups",
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new account user profile.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "POST",
+ "id": "dfareporting.accountUserProfiles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "advertiserLandingPages": {
- "methods": {
- "get": {
- "description": "Gets one landing page by ID.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserLandingPages.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Landing page ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages/{id}",
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new landing page.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "POST",
- "id": "dfareporting.advertiserLandingPages.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of landing pages.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "GET",
- "id": "dfareporting.advertiserLandingPages.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only landing pages that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only landing pages that are associated with these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only landing pages with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only landing pages that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "response": {
- "$ref": "AdvertiserLandingPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser landing page. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertiserLandingPages.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "LandingPage ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing landing page.",
- "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
- "httpMethod": "PUT",
- "id": "dfareporting.advertiserLandingPages.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertiserLandingPages",
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active user profiles.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user profiles with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user profiles with the specified subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "userRoleId": {
+ "description": "Select only user profiles with the specified user role ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "advertisers": {
- "methods": {
- "get": {
- "description": "Gets one advertiser by ID.",
- "flatPath": "userprofiles/{profileId}/advertisers/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.advertisers.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers/{id}",
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new advertiser.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "POST",
- "id": "dfareporting.advertisers.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "GET",
- "id": "dfareporting.advertisers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserGroupIds": {
- "description": "Select only advertisers with these advertiser group IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "floodlightConfigurationIds": {
- "description": "Select only advertisers with these floodlight configuration IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only advertisers with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "includeAdvertisersWithoutGroupsOnly": {
- "description": "Select only advertisers which do not belong to any advertiser group.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "onlyParent": {
- "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- "location": "query",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "status": {
- "description": "Select only advertisers with the specified status.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only advertisers with these subaccount IDs.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "response": {
- "$ref": "AdvertisersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing advertiser. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PATCH",
- "id": "dfareporting.advertisers.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Advertiser ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing advertiser.",
- "flatPath": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PUT",
- "id": "dfareporting.advertisers.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/advertisers",
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "response": {
+ "$ref": "AccountUserProfilesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account user profile. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accountUserProfiles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AccountUserProfile ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "browsers": {
- "methods": {
- "list": {
- "description": "Retrieves a list of browsers.",
- "flatPath": "userprofiles/{profileId}/browsers",
- "httpMethod": "GET",
- "id": "dfareporting.browsers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/browsers",
- "response": {
- "$ref": "BrowsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account user profile.",
+ "flatPath": "userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accountUserProfiles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "campaignCreativeAssociations": {
- "methods": {
- "insert": {
- "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "POST",
- "id": "dfareporting.campaignCreativeAssociations.insert",
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Campaign ID in this association.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "request": {
- "$ref": "CampaignCreativeAssociation"
- },
- "response": {
- "$ref": "CampaignCreativeAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "GET",
- "id": "dfareporting.campaignCreativeAssociations.list",
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Campaign ID in this association.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "response": {
- "$ref": "CampaignCreativeAssociationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "flatPath": "userprofiles/{profileId}/accounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "campaigns": {
- "methods": {
- "get": {
- "description": "Gets one campaign by ID.",
- "flatPath": "userprofiles/{profileId}/campaigns/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.campaigns.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Campaign ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns/{id}",
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new campaign.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "POST",
- "id": "dfareporting.campaigns.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "GET",
- "id": "dfareporting.campaigns.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserGroupIds": {
- "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "advertiserIds": {
- "description": "Select only campaigns that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- "location": "query",
- "type": "boolean"
- },
- "atLeastOneOptimizationActivity": {
- "description": "Select only campaigns that have at least one optimization activity.",
- "location": "query",
- "type": "boolean"
- },
- "excludedIds": {
- "description": "Exclude campaigns with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only campaigns with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "overriddenEventTagId": {
- "description": "Select only campaigns that have overridden this event tag ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only campaigns that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "response": {
- "$ref": "CampaignsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing campaign. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PATCH",
- "id": "dfareporting.campaigns.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Campaign ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing campaign.",
- "flatPath": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PUT",
- "id": "dfareporting.campaigns.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/campaigns",
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only accounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "changeLogs": {
- "methods": {
- "get": {
- "description": "Gets one change log by ID.",
- "flatPath": "userprofiles/{profileId}/changeLogs/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.changeLogs.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Change log ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/changeLogs/{id}",
- "response": {
- "$ref": "ChangeLog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of change logs. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/changeLogs",
- "httpMethod": "GET",
- "id": "dfareporting.changeLogs.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "action": {
- "description": "Select only change logs with the specified action.",
- "enum": [
- "ACTION_CREATE",
- "ACTION_UPDATE",
- "ACTION_DELETE",
- "ACTION_ENABLE",
- "ACTION_DISABLE",
- "ACTION_ADD",
- "ACTION_REMOVE",
- "ACTION_MARK_AS_DEFAULT",
- "ACTION_ASSOCIATE",
- "ACTION_ASSIGN",
- "ACTION_UNASSIGN",
- "ACTION_SEND",
- "ACTION_LINK",
- "ACTION_UNLINK",
- "ACTION_PUSH",
- "ACTION_EMAIL_TAGS",
- "ACTION_SHARE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only change logs with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxChangeTime": {
- "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "minChangeTime": {
- "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query",
- "type": "string"
- },
- "objectIds": {
- "description": "Select only change logs with these object IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "objectType": {
- "description": "Select only change logs with the specified object type.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_FLOODLIGHT_CONFIGURATION",
- "OBJECT_AD",
- "OBJECT_FLOODLIGHT_ACTVITY",
- "OBJECT_CAMPAIGN",
- "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT",
- "OBJECT_DFA_SITE",
- "OBJECT_USER_ROLE",
- "OBJECT_USER_PROFILE",
- "OBJECT_ADVERTISER_GROUP",
- "OBJECT_ACCOUNT",
- "OBJECT_SUBACCOUNT",
- "OBJECT_RICHMEDIA_CREATIVE",
- "OBJECT_INSTREAM_CREATIVE",
- "OBJECT_MEDIA_ORDER",
- "OBJECT_CONTENT_CATEGORY",
- "OBJECT_PLACEMENT_STRATEGY",
- "OBJECT_SD_SITE",
- "OBJECT_SIZE",
- "OBJECT_CREATIVE_GROUP",
- "OBJECT_CREATIVE_ASSET",
- "OBJECT_USER_PROFILE_FILTER",
- "OBJECT_LANDING_PAGE",
- "OBJECT_CREATIVE_FIELD",
- "OBJECT_REMARKETING_LIST",
- "OBJECT_PROVIDED_LIST_CLIENT",
- "OBJECT_EVENT_TAG",
- "OBJECT_CREATIVE_BUNDLE",
- "OBJECT_BILLING_ACCOUNT_GROUP",
- "OBJECT_BILLING_FEATURE",
- "OBJECT_RATE_CARD",
- "OBJECT_ACCOUNT_BILLING_FEATURE",
- "OBJECT_BILLING_MINIMUM_FEE",
- "OBJECT_BILLING_PROFILE",
- "OBJECT_PLAYSTORE_LINK",
- "OBJECT_TARGETING_TEMPLATE",
- "OBJECT_SEARCH_LIFT_STUDY",
- "OBJECT_FLOODLIGHT_DV360_LINK"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- "location": "query",
- "type": "string"
- },
- "userProfileIds": {
- "description": "Select only change logs with these user profile IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/changeLogs",
- "response": {
- "$ref": "ChangeLogsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "response": {
+ "$ref": "AccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "cities": {
- "methods": {
- "list": {
- "description": "Retrieves a list of cities, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/cities",
- "httpMethod": "GET",
- "id": "dfareporting.cities.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "countryDartIds": {
- "description": "Select only cities from these countries.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "dartIds": {
- "description": "Select only cities with these DART IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "namePrefix": {
- "description": "Select only cities with names starting with this prefix.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionDartIds": {
- "description": "Select only cities from these regions.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/cities",
- "response": {
- "$ref": "CitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "flatPath": "userprofiles/{profileId}/accounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "connectionTypes": {
- "methods": {
- "get": {
- "description": "Gets one connection type by ID.",
- "flatPath": "userprofiles/{profileId}/connectionTypes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.connectionTypes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Connection type ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/connectionTypes/{id}",
- "response": {
- "$ref": "ConnectionType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of connection types.",
- "flatPath": "userprofiles/{profileId}/connectionTypes",
- "httpMethod": "GET",
- "id": "dfareporting.connectionTypes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/connectionTypes",
- "response": {
- "$ref": "ConnectionTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "ads": {
+ "methods": {
+ "get": {
+ "description": "Gets one ad by ID.",
+ "flatPath": "userprofiles/{profileId}/ads/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "contentCategories": {
- "methods": {
- "delete": {
- "description": "Deletes an existing content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.contentCategories.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Content category ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one content category by ID.",
- "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.contentCategories.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Content category ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "POST",
- "id": "dfareporting.contentCategories.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "GET",
- "id": "dfareporting.contentCategories.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only content categories with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "response": {
- "$ref": "ContentCategoriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing content category. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PATCH",
- "id": "dfareporting.contentCategories.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "ContentCategory ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing content category.",
- "flatPath": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PUT",
- "id": "dfareporting.contentCategories.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/contentCategories",
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads/{id}",
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new ad.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "POST",
+ "id": "dfareporting.ads.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "conversions": {
- "methods": {
- "batchinsert": {
- "description": "Inserts conversions.",
- "flatPath": "userprofiles/{profileId}/conversions/batchinsert",
- "httpMethod": "POST",
- "id": "dfareporting.conversions.batchinsert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/conversions/batchinsert",
- "request": {
- "$ref": "ConversionsBatchInsertRequest"
- },
- "response": {
- "$ref": "ConversionsBatchInsertResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions"
- ]
- },
- "batchupdate": {
- "description": "Updates existing conversions.",
- "flatPath": "userprofiles/{profileId}/conversions/batchupdate",
- "httpMethod": "POST",
- "id": "dfareporting.conversions.batchupdate",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/conversions/batchupdate",
- "request": {
- "$ref": "ConversionsBatchUpdateRequest"
- },
- "response": {
- "$ref": "ConversionsBatchUpdateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only ads with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "audienceSegmentIds": {
+ "description": "Select only ads with these audience segment IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "campaignIds": {
+ "description": "Select only ads with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "creativeIds": {
+ "description": "Select only ads with these creative IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "creativeOptimizationConfigurationIds": {
+ "description": "Select only ads with these creative optimization configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dynamicClickTracker": {
+ "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only ads with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "landingPageIds": {
+ "description": "Select only ads with these landing page IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only ads with this event tag override ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Select only ads with these placement IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListIds": {
+ "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only ads with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sslCompliant": {
+ "description": "Select only ads that are SSL-compliant.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Select only ads that require SSL.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Select only ads with these types.",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "countries": {
- "methods": {
- "get": {
- "description": "Gets one country by ID.",
- "flatPath": "userprofiles/{profileId}/countries/{dartId}",
- "httpMethod": "GET",
- "id": "dfareporting.countries.get",
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "parameters": {
- "dartId": {
- "description": "Country DART ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/countries/{dartId}",
- "response": {
- "$ref": "Country"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of countries.",
- "flatPath": "userprofiles/{profileId}/countries",
- "httpMethod": "GET",
- "id": "dfareporting.countries.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/countries",
- "response": {
- "$ref": "CountriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "response": {
+ "$ref": "AdsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing ad. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.ads.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeAssets": {
- "methods": {
- "insert": {
- "description": "Inserts a new creative asset.",
- "flatPath": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "httpMethod": "POST",
- "id": "dfareporting.creativeAssets.insert",
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "1073741824",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/dfareporting/v3.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- }
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Advertiser ID of this creative. This is a required field.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "request": {
- "$ref": "CreativeAssetMetadata"
- },
- "response": {
- "$ref": "CreativeAssetMetadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ],
- "supportsMediaUpload": true
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing ad.",
+ "flatPath": "userprofiles/{profileId}/ads",
+ "httpMethod": "PUT",
+ "id": "dfareporting.ads.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeFieldValues": {
- "methods": {
- "delete": {
- "description": "Deletes an existing creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.creativeFieldValues.delete",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Creative Field Value ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one creative field value by ID.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFieldValues.get",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Creative Field Value ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "POST",
- "id": "dfareporting.creativeFieldValues.insert",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFieldValues.list",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creative field values with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "VALUE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "response": {
- "$ref": "CreativeFieldValuesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative field value. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeFieldValues.patch",
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "CreativeField ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "CreativeFieldValue ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative field value.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeFieldValues.update",
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "parameters": {
- "creativeFieldId": {
- "description": "Creative field ID for this creative field value.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserGroups": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.advertiserGroups.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeFields": {
- "methods": {
- "delete": {
- "description": "Deletes an existing creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.creativeFields.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative Field ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one creative field by ID.",
- "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFields.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative Field ID",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "POST",
- "id": "dfareporting.creativeFields.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "GET",
- "id": "dfareporting.creativeFields.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only creative fields that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creative fields with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "response": {
- "$ref": "CreativeFieldsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative field. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeFields.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "CreativeField ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative field.",
- "flatPath": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeFields.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeFields",
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one advertiser group by ID.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creativeGroups": {
- "methods": {
- "get": {
- "description": "Gets one creative group by ID.",
- "flatPath": "userprofiles/{profileId}/creativeGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creativeGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups/{id}",
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative group.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "POST",
- "id": "dfareporting.creativeGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "GET",
- "id": "dfareporting.creativeGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only creative groups that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "groupNumber": {
- "description": "Select only creative groups that belong to this subgroup.",
- "format": "int32",
- "location": "query",
- "maximum": "2",
- "minimum": "1",
- "type": "integer"
- },
- "ids": {
- "description": "Select only creative groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "response": {
- "$ref": "CreativeGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.creativeGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "CreativeGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative group.",
- "flatPath": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.creativeGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creativeGroups",
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups/{id}",
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "creatives": {
- "methods": {
- "get": {
- "description": "Gets one creative by ID.",
- "flatPath": "userprofiles/{profileId}/creatives/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.creatives.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives/{id}",
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new creative.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "POST",
- "id": "dfareporting.creatives.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "GET",
- "id": "dfareporting.creatives.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only creatives with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "archived": {
- "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- "location": "query",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Select only creatives with this campaign ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "companionCreativeIds": {
- "description": "Select only in-stream video creatives with these companion IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "creativeFieldIds": {
- "description": "Select only creatives with these creative field IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only creatives with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "renderingIds": {
- "description": "Select only creatives with these rendering IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- "location": "query",
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only creatives with these size IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "studioCreativeId": {
- "description": "Select only creatives corresponding to this Studio creative ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "types": {
- "description": "Select only creatives with these creative types.",
- "enum": [
- "IMAGE",
- "DISPLAY_REDIRECT",
- "CUSTOM_DISPLAY",
- "INTERNAL_REDIRECT",
- "CUSTOM_DISPLAY_INTERSTITIAL",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "TRACKING_TEXT",
- "RICH_MEDIA_DISPLAY_BANNER",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_DISPLAY_EXPANDING",
- "RICH_MEDIA_DISPLAY_INTERSTITIAL",
- "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
- "RICH_MEDIA_MOBILE_IN_APP",
- "FLASH_INPAGE",
- "INSTREAM_VIDEO",
- "VPAID_LINEAR_VIDEO",
- "VPAID_NON_LINEAR_VIDEO",
- "INSTREAM_VIDEO_REDIRECT",
- "RICH_MEDIA_PEEL_DOWN",
- "HTML5_BANNER",
- "DISPLAY",
- "DISPLAY_IMAGE_GALLERY",
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "INSTREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "response": {
- "$ref": "CreativesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing creative. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "PATCH",
- "id": "dfareporting.creatives.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Creative ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing creative.",
- "flatPath": "userprofiles/{profileId}/creatives",
- "httpMethod": "PUT",
- "id": "dfareporting.creatives.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only advertiser groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "customEvents": {
- "methods": {
- "batchinsert": {
- "description": "Inserts custom events.",
- "flatPath": "userprofiles/{profileId}/customEvents/batchinsert",
- "httpMethod": "POST",
- "id": "dfareporting.customEvents.batchinsert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/customEvents/batchinsert",
- "request": {
- "$ref": "CustomEventsBatchInsertRequest"
- },
- "response": {
- "$ref": "CustomEventsBatchInsertResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "response": {
+ "$ref": "AdvertiserGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AdvertiserGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "dimensionValues": {
- "methods": {
- "query": {
- "description": "Retrieves list of report dimension values for a list of filters.",
- "flatPath": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "id": "dfareporting.dimensionValues.query",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "100",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "100",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser group.",
+ "flatPath": "userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "directorySites": {
- "methods": {
- "get": {
- "description": "Gets one directory site by ID.",
- "flatPath": "userprofiles/{profileId}/directorySites/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.directorySites.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Directory site ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites/{id}",
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new directory site.",
- "flatPath": "userprofiles/{profileId}/directorySites",
- "httpMethod": "POST",
- "id": "dfareporting.directorySites.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites",
- "request": {
- "$ref": "DirectorySite"
- },
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/directorySites",
- "httpMethod": "GET",
- "id": "dfareporting.directorySites.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsInterstitialPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsPublisherPaidPlacements": {
- "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- "location": "query",
- "type": "boolean"
- },
- "active": {
- "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- "location": "query",
- "type": "boolean"
- },
- "dfpNetworkCode": {
- "description": "Select only directory sites with this Ad Manager network code.",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only directory sites with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/directorySites",
- "response": {
- "$ref": "DirectorySitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserLandingPages": {
+ "methods": {
+ "get": {
+ "description": "Gets one landing page by ID.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Landing page ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "dynamicTargetingKeys": {
- "methods": {
- "delete": {
- "description": "Deletes an existing dynamic targeting key.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
- "httpMethod": "DELETE",
- "id": "dfareporting.dynamicTargetingKeys.delete",
- "parameterOrder": [
- "profileId",
- "objectId",
- "name",
- "objectType"
- ],
- "parameters": {
- "name": {
- "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this dynamic targeting key. This is a required field.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "objectType": {
- "description": "Type of the object of this dynamic targeting key. This is a required field.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
- "httpMethod": "POST",
- "id": "dfareporting.dynamicTargetingKeys.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys",
- "request": {
- "$ref": "DynamicTargetingKey"
- },
- "response": {
- "$ref": "DynamicTargetingKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of dynamic targeting keys.",
- "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
- "httpMethod": "GET",
- "id": "dfareporting.dynamicTargetingKeys.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "names": {
- "description": "Select only dynamic targeting keys exactly matching these names.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "objectId": {
- "description": "Select only dynamic targeting keys with this object ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "objectType": {
- "description": "Select only dynamic targeting keys with this object type.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/dynamicTargetingKeys",
- "response": {
- "$ref": "DynamicTargetingKeysListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new landing page.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserLandingPages.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "eventTags": {
- "methods": {
- "delete": {
- "description": "Deletes an existing event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.eventTags.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Event tag ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one event tag by ID.",
- "flatPath": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.eventTags.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Event tag ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "POST",
- "id": "dfareporting.eventTags.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of event tags, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "GET",
- "id": "dfareporting.eventTags.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "adId": {
- "description": "Select only event tags that belong to this ad.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "advertiserId": {
- "description": "Select only event tags that belong to this advertiser.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "campaignId": {
- "description": "Select only event tags that belong to this campaign.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "definitionsOnly": {
- "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- "location": "query",
- "type": "boolean"
- },
- "enabled": {
- "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- "location": "query",
- "type": "boolean"
- },
- "eventTagTypes": {
- "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- "enum": [
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG",
- "CLICK_THROUGH_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only event tags with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "response": {
- "$ref": "EventTagsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing event tag. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PATCH",
- "id": "dfareporting.eventTags.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "EventTag ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing event tag.",
- "flatPath": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PUT",
- "id": "dfareporting.eventTags.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/eventTags",
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
- "flatPath": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "id": "dfareporting.files.get",
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "parameters": {
- "fileId": {
- "description": "The ID of the report file.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "reports/{reportId}/files/{fileId}",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "description": "Lists files for a user profile.",
- "flatPath": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "id": "dfareporting.files.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "scope": {
- "default": "MINE",
- "description": "The scope that defines which results are returned.",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/files",
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of landing pages.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only landing pages that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only landing pages that are associated with these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only landing pages with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only landing pages that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "floodlightActivities": {
- "methods": {
- "delete": {
- "description": "Deletes an existing floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.floodlightActivities.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "generatetag": {
- "description": "Generates a tag for a floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivities.generatetag",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID for which we want to generate a tag.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "response": {
- "$ref": "FloodlightActivitiesGenerateTagResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one floodlight activity by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivities.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivities.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivities.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupIds": {
- "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "floodlightActivityGroupName": {
- "description": "Select only floodlight activities with the specified floodlight activity group name.",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupTagString": {
- "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- "location": "query",
- "type": "string"
- },
- "floodlightActivityGroupType": {
- "description": "Select only floodlight activities with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "tagString": {
- "description": "Select only floodlight activities with the specified tag string.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "response": {
- "$ref": "FloodlightActivitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightActivities.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightActivity ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight activity.",
- "flatPath": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightActivities.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivities",
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "response": {
+ "$ref": "AdvertiserLandingPagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser landing page. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserLandingPages.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "LandingPage ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "floodlightActivityGroups": {
- "methods": {
- "get": {
- "description": "Gets one floodlight activity group by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivityGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight activity Group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new floodlight activity group.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "POST",
- "id": "dfareporting.floodlightActivityGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightActivityGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "type": {
- "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "response": {
- "$ref": "FloodlightActivityGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightActivityGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightActivityGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight activity group.",
- "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightActivityGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing landing page.",
+ "flatPath": "userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserLandingPages.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "floodlightConfigurations": {
- "methods": {
- "get": {
- "description": "Gets one floodlight configuration by ID.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightConfigurations.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Floodlight configuration ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "GET",
- "id": "dfareporting.floodlightConfigurations.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "response": {
- "$ref": "FloodlightConfigurationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PATCH",
- "id": "dfareporting.floodlightConfigurations.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "FloodlightConfiguration ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing floodlight configuration.",
- "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PUT",
- "id": "dfareporting.floodlightConfigurations.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertisers": {
+ "methods": {
+ "get": {
+ "description": "Gets one advertiser by ID.",
+ "flatPath": "userprofiles/{profileId}/advertisers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "inventoryItems": {
- "methods": {
- "get": {
- "description": "Gets one inventory item by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.inventoryItems.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Inventory item ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "response": {
- "$ref": "InventoryItem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "httpMethod": "GET",
- "id": "dfareporting.inventoryItems.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only inventory items with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "inPlan": {
- "description": "Select only inventory items that are in plan.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "orderId": {
- "description": "Select only inventory items that belong to specified orders.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "siteId": {
- "description": "Select only inventory items that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "type": {
- "description": "Select only inventory items with this type.",
- "enum": [
- "PLANNING_PLACEMENT_TYPE_REGULAR",
- "PLANNING_PLACEMENT_TYPE_CREDIT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "response": {
- "$ref": "InventoryItemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers/{id}",
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertisers.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "languages": {
- "methods": {
- "list": {
- "description": "Retrieves a list of languages.",
- "flatPath": "userprofiles/{profileId}/languages",
- "httpMethod": "GET",
- "id": "dfareporting.languages.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/languages",
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only advertisers with these advertiser group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "floodlightConfigurationIds": {
+ "description": "Select only advertisers with these floodlight configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only advertisers with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "includeAdvertisersWithoutGroupsOnly": {
+ "description": "Select only advertisers which do not belong to any advertiser group.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "onlyParent": {
+ "description": "Select only advertisers which use another advertiser's floodlight configuration.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Select only advertisers with the specified status.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only advertisers with these subaccount IDs.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "metros": {
- "methods": {
- "list": {
- "description": "Retrieves a list of metros.",
- "flatPath": "userprofiles/{profileId}/metros",
- "httpMethod": "GET",
- "id": "dfareporting.metros.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/metros",
- "response": {
- "$ref": "MetrosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "response": {
+ "$ref": "AdvertisersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertisers.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "mobileApps": {
- "methods": {
- "get": {
- "description": "Gets one mobile app by ID.",
- "flatPath": "userprofiles/{profileId}/mobileApps/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.mobileApps.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Mobile app ID.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileApps/{id}",
- "response": {
- "$ref": "MobileApp"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves list of available mobile apps.",
- "flatPath": "userprofiles/{profileId}/mobileApps",
- "httpMethod": "GET",
- "id": "dfareporting.mobileApps.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "directories": {
- "description": "Select only apps from these directories.",
- "enum": [
- "UNKNOWN",
- "APPLE_APP_STORE",
- "GOOGLE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only apps with these IDs.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileApps",
- "response": {
- "$ref": "MobileAppsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser.",
+ "flatPath": "userprofiles/{profileId}/advertisers",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertisers.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "mobileCarriers": {
- "methods": {
- "get": {
- "description": "Gets one mobile carrier by ID.",
- "flatPath": "userprofiles/{profileId}/mobileCarriers/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.mobileCarriers.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Mobile carrier ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileCarriers/{id}",
- "response": {
- "$ref": "MobileCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of mobile carriers.",
- "flatPath": "userprofiles/{profileId}/mobileCarriers",
- "httpMethod": "GET",
- "id": "dfareporting.mobileCarriers.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/mobileCarriers",
- "response": {
- "$ref": "MobileCarriersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "browsers": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of browsers.",
+ "flatPath": "userprofiles/{profileId}/browsers",
+ "httpMethod": "GET",
+ "id": "dfareporting.browsers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "operatingSystemVersions": {
- "methods": {
- "get": {
- "description": "Gets one operating system version by ID.",
- "flatPath": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystemVersions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Operating system version ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "response": {
- "$ref": "OperatingSystemVersion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of operating system versions.",
- "flatPath": "userprofiles/{profileId}/operatingSystemVersions",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystemVersions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystemVersions",
- "response": {
- "$ref": "OperatingSystemVersionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/browsers",
+ "response": {
+ "$ref": "BrowsersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaignCreativeAssociations": {
+ "methods": {
+ "insert": {
+ "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaignCreativeAssociations.insert",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "operatingSystems": {
- "methods": {
- "get": {
- "description": "Gets one operating system by DART ID.",
- "flatPath": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystems.get",
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "parameters": {
- "dartId": {
- "description": "Operating system DART ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "response": {
- "$ref": "OperatingSystem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of operating systems.",
- "flatPath": "userprofiles/{profileId}/operatingSystems",
- "httpMethod": "GET",
- "id": "dfareporting.operatingSystems.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/operatingSystems",
- "response": {
- "$ref": "OperatingSystemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "request": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "response": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaignCreativeAssociations.list",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "orderDocuments": {
- "methods": {
- "get": {
- "description": "Gets one order document by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.orderDocuments.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Order document ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "response": {
- "$ref": "OrderDocument"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "httpMethod": "GET",
- "id": "dfareporting.orderDocuments.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "approved": {
- "description": "Select only order documents that have been approved by at least one user.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only order documents with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "orderId": {
- "description": "Select only order documents for specified orders.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for order documents.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
- "location": "query",
- "type": "string"
- },
- "siteId": {
- "description": "Select only order documents that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "response": {
- "$ref": "OrderDocumentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "response": {
+ "$ref": "CampaignCreativeAssociationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaigns": {
+ "methods": {
+ "get": {
+ "description": "Gets one campaign by ID.",
+ "flatPath": "userprofiles/{profileId}/campaigns/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "orders": {
- "methods": {
- "get": {
- "description": "Gets one order by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.orders.get",
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Order ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for orders.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders",
- "httpMethod": "GET",
- "id": "dfareporting.orders.list",
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only orders with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Project ID for orders.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
- "location": "query",
- "type": "string"
- },
- "siteId": {
- "description": "Select only orders that are associated with these site IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{projectId}/orders",
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns/{id}",
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new campaign.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaigns.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "placementGroups": {
- "methods": {
- "get": {
- "description": "Gets one placement group by ID.",
- "flatPath": "userprofiles/{profileId}/placementGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placementGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups/{id}",
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement group.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "POST",
- "id": "dfareporting.placementGroups.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "GET",
- "id": "dfareporting.placementGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only placement groups that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only placement groups that belong to these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "contentCategoryIds": {
- "description": "Select only placement groups that are associated with these content categories.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only placement groups that are associated with these directory sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only placement groups with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxEndDate": {
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "800",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "800",
- "minimum": "0",
- "type": "integer"
- },
- "maxStartDate": {
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minEndDate": {
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minStartDate": {
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "placementGroupType": {
- "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "placementStrategyIds": {
- "description": "Select only placement groups that are associated with these placement strategies.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pricingTypes": {
- "description": "Select only placement groups with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- "location": "query",
- "type": "string"
- },
- "siteIds": {
- "description": "Select only placement groups that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "response": {
- "$ref": "PlacementGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement group. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PATCH",
- "id": "dfareporting.placementGroups.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "PlacementGroup ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement group.",
- "flatPath": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PUT",
- "id": "dfareporting.placementGroups.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementGroups",
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "advertiserIds": {
+ "description": "Select only campaigns that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "atLeastOneOptimizationActivity": {
+ "description": "Select only campaigns that have at least one optimization activity.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "excludedIds": {
+ "description": "Exclude campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only campaigns that have overridden this event tag ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only campaigns that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
}
- },
- "placementStrategies": {
- "methods": {
- "delete": {
- "description": "Deletes an existing placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.placementStrategies.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement strategy ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one placement strategy by ID.",
- "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placementStrategies.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement strategy ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "POST",
- "id": "dfareporting.placementStrategies.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "GET",
- "id": "dfareporting.placementStrategies.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only placement strategies with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "response": {
- "$ref": "PlacementStrategiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement strategy. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PATCH",
- "id": "dfareporting.placementStrategies.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "PlacementStrategy ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement strategy.",
- "flatPath": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PUT",
- "id": "dfareporting.placementStrategies.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placementStrategies",
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "response": {
+ "$ref": "CampaignsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing campaign. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.campaigns.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "placements": {
- "methods": {
- "generatetags": {
- "description": "Generates tags for a placement.",
- "flatPath": "userprofiles/{profileId}/placements/generatetags",
- "httpMethod": "POST",
- "id": "dfareporting.placements.generatetags",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "campaignId": {
- "description": "Generate placements belonging to this campaign. This is a required field.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "placementIds": {
- "description": "Generate tags for these placements.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "tagFormats": {
- "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements/generatetags",
- "response": {
- "$ref": "PlacementsGenerateTagsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one placement by ID.",
- "flatPath": "userprofiles/{profileId}/placements/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.placements.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements/{id}",
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new placement.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "POST",
- "id": "dfareporting.placements.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "GET",
- "id": "dfareporting.placements.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only placements that belong to these advertisers.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "archived": {
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only placements that belong to these campaigns.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "compatibilities": {
- "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "contentCategoryIds": {
- "description": "Select only placements that are associated with these content categories.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only placements that are associated with these directory sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "groupIds": {
- "description": "Select only placements that belong to these placement groups.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only placements with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxEndDate": {
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "maxStartDate": {
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minEndDate": {
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "minStartDate": {
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "paymentSource": {
- "description": "Select only placements with this payment source.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "placementStrategyIds": {
- "description": "Select only placements that are associated with these placement strategies.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "pricingTypes": {
- "description": "Select only placements with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .",
- "location": "query",
- "type": "string"
- },
- "siteIds": {
- "description": "Select only placements that are associated with these sites.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sizeIds": {
- "description": "Select only placements that are associated with these sizes.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "response": {
- "$ref": "PlacementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing placement. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "PATCH",
- "id": "dfareporting.placements.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Placement ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing placement.",
- "flatPath": "userprofiles/{profileId}/placements",
- "httpMethod": "PUT",
- "id": "dfareporting.placements.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/placements",
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing campaign.",
+ "flatPath": "userprofiles/{profileId}/campaigns",
+ "httpMethod": "PUT",
+ "id": "dfareporting.campaigns.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "platformTypes": {
- "methods": {
- "get": {
- "description": "Gets one platform type by ID.",
- "flatPath": "userprofiles/{profileId}/platformTypes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.platformTypes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Platform type ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/platformTypes/{id}",
- "response": {
- "$ref": "PlatformType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of platform types.",
- "flatPath": "userprofiles/{profileId}/platformTypes",
- "httpMethod": "GET",
- "id": "dfareporting.platformTypes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/platformTypes",
- "response": {
- "$ref": "PlatformTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "changeLogs": {
+ "methods": {
+ "get": {
+ "description": "Gets one change log by ID.",
+ "flatPath": "userprofiles/{profileId}/changeLogs/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Change log ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "postalCodes": {
- "methods": {
- "get": {
- "description": "Gets one postal code by ID.",
- "flatPath": "userprofiles/{profileId}/postalCodes/{code}",
- "httpMethod": "GET",
- "id": "dfareporting.postalCodes.get",
- "parameterOrder": [
- "profileId",
- "code"
- ],
- "parameters": {
- "code": {
- "description": "Postal code ID.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/postalCodes/{code}",
- "response": {
- "$ref": "PostalCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of postal codes.",
- "flatPath": "userprofiles/{profileId}/postalCodes",
- "httpMethod": "GET",
- "id": "dfareporting.postalCodes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/postalCodes",
- "response": {
- "$ref": "PostalCodesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/changeLogs/{id}",
+ "response": {
+ "$ref": "ChangeLog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of change logs. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/changeLogs",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "action": {
+ "description": "Select only change logs with the specified action.",
+ "enum": [
+ "ACTION_CREATE",
+ "ACTION_UPDATE",
+ "ACTION_DELETE",
+ "ACTION_ENABLE",
+ "ACTION_DISABLE",
+ "ACTION_ADD",
+ "ACTION_REMOVE",
+ "ACTION_MARK_AS_DEFAULT",
+ "ACTION_ASSOCIATE",
+ "ACTION_ASSIGN",
+ "ACTION_UNASSIGN",
+ "ACTION_SEND",
+ "ACTION_LINK",
+ "ACTION_UNLINK",
+ "ACTION_PUSH",
+ "ACTION_EMAIL_TAGS",
+ "ACTION_SHARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only change logs with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxChangeTime": {
+ "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "minChangeTime": {
+ "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Select only change logs with these object IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Select only change logs with the specified object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_FLOODLIGHT_CONFIGURATION",
+ "OBJECT_AD",
+ "OBJECT_FLOODLIGHT_ACTVITY",
+ "OBJECT_CAMPAIGN",
+ "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT",
+ "OBJECT_DFA_SITE",
+ "OBJECT_USER_ROLE",
+ "OBJECT_USER_PROFILE",
+ "OBJECT_ADVERTISER_GROUP",
+ "OBJECT_ACCOUNT",
+ "OBJECT_SUBACCOUNT",
+ "OBJECT_RICHMEDIA_CREATIVE",
+ "OBJECT_INSTREAM_CREATIVE",
+ "OBJECT_MEDIA_ORDER",
+ "OBJECT_CONTENT_CATEGORY",
+ "OBJECT_PLACEMENT_STRATEGY",
+ "OBJECT_SD_SITE",
+ "OBJECT_SIZE",
+ "OBJECT_CREATIVE_GROUP",
+ "OBJECT_CREATIVE_ASSET",
+ "OBJECT_USER_PROFILE_FILTER",
+ "OBJECT_LANDING_PAGE",
+ "OBJECT_CREATIVE_FIELD",
+ "OBJECT_REMARKETING_LIST",
+ "OBJECT_PROVIDED_LIST_CLIENT",
+ "OBJECT_EVENT_TAG",
+ "OBJECT_CREATIVE_BUNDLE",
+ "OBJECT_BILLING_ACCOUNT_GROUP",
+ "OBJECT_BILLING_FEATURE",
+ "OBJECT_RATE_CARD",
+ "OBJECT_ACCOUNT_BILLING_FEATURE",
+ "OBJECT_BILLING_MINIMUM_FEE",
+ "OBJECT_BILLING_PROFILE",
+ "OBJECT_PLAYSTORE_LINK",
+ "OBJECT_TARGETING_TEMPLATE",
+ "OBJECT_SEARCH_LIFT_STUDY",
+ "OBJECT_FLOODLIGHT_DV360_LINK"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
+ "location": "query",
+ "type": "string"
+ },
+ "userProfileIds": {
+ "description": "Select only change logs with these user profile IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "projects": {
- "methods": {
- "get": {
- "description": "Gets one project by ID.",
- "flatPath": "userprofiles/{profileId}/projects/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.projects.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Project ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects/{id}",
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
- "flatPath": "userprofiles/{profileId}/projects",
- "httpMethod": "GET",
- "id": "dfareporting.projects.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserIds": {
- "description": "Select only projects with these advertiser IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only projects with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/projects",
- "response": {
- "$ref": "ProjectsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/changeLogs",
+ "response": {
+ "$ref": "ChangeLogsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "cities": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of cities, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/cities",
+ "httpMethod": "GET",
+ "id": "dfareporting.cities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "countryDartIds": {
+ "description": "Select only cities from these countries.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dartIds": {
+ "description": "Select only cities with these DART IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "namePrefix": {
+ "description": "Select only cities with names starting with this prefix.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionDartIds": {
+ "description": "Select only cities from these regions.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
- },
- "regions": {
- "methods": {
- "list": {
- "description": "Retrieves a list of regions.",
- "flatPath": "userprofiles/{profileId}/regions",
- "httpMethod": "GET",
- "id": "dfareporting.regions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/regions",
- "response": {
- "$ref": "RegionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/cities",
+ "response": {
+ "$ref": "CitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "connectionTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one connection type by ID.",
+ "flatPath": "userprofiles/{profileId}/connectionTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Connection type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "remarketingListShares": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list share by remarketing list ID.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingListShares.get",
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "remarketingListId": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing remarketing list share. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PATCH",
- "id": "dfareporting.remarketingListShares.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "RemarketingList ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares",
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing remarketing list share.",
- "flatPath": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PUT",
- "id": "dfareporting.remarketingListShares.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingListShares",
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/connectionTypes/{id}",
+ "response": {
+ "$ref": "ConnectionType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of connection types.",
+ "flatPath": "userprofiles/{profileId}/connectionTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "remarketingLists": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list by ID.",
- "flatPath": "userprofiles/{profileId}/remarketingLists/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingLists.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists/{id}",
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new remarketing list.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "POST",
- "id": "dfareporting.remarketingLists.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "GET",
- "id": "dfareporting.remarketingLists.list",
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active or only inactive remarketing lists.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only remarketing lists owned by this advertiser.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "floodlightActivityId": {
- "description": "Select only remarketing lists that have this floodlight activity ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "name": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "response": {
- "$ref": "RemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing remarketing list. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PATCH",
- "id": "dfareporting.remarketingLists.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "RemarketingList ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing remarketing list.",
- "flatPath": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PUT",
- "id": "dfareporting.remarketingLists.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/remarketingLists",
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/connectionTypes",
+ "response": {
+ "$ref": "ConnectionTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "contentCategories": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.contentCategories.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "reports": {
- "methods": {
- "delete": {
- "description": "Deletes a report by its ID.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "id": "dfareporting.reports.delete",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "description": "Retrieves a report by its ID.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "id": "dfareporting.reports.get",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "description": "Creates a report.",
- "flatPath": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "id": "dfareporting.reports.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "description": "Retrieves list of reports.",
- "flatPath": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "id": "dfareporting.reports.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "scope": {
- "default": "MINE",
- "description": "The scope that defines which results are returned.",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports",
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "description": "Updates an existing report. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "id": "dfareporting.reports.patch",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The DFA user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "description": "Runs a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "id": "dfareporting.reports.run",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "synchronous": {
- "default": "false",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "description": "Updates a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "id": "dfareporting.reports.update",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one content category by ID.",
+ "flatPath": "userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "flatPath": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "id": "dfareporting.reports.compatibleFields.query",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "id": "dfareporting.reports.files.get",
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "parameters": {
- "fileId": {
- "description": "The ID of the report file.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "description": "Lists files for a report.",
- "flatPath": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "id": "dfareporting.reports.files.list",
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "parameters": {
- "maxResults": {
- "default": "10",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "10",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value of the nextToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "The Campaign Manager 360 user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the parent report.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "LAST_MODIFIED_TIME",
- "description": "The field by which to sort the list.",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "DESCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "sites": {
- "methods": {
- "get": {
- "description": "Gets one site by ID.",
- "flatPath": "userprofiles/{profileId}/sites/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.sites.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Site ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites/{id}",
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new site.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "POST",
- "id": "dfareporting.sites.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "GET",
- "id": "dfareporting.sites.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsInterstitialPlacements": {
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query",
- "type": "boolean"
- },
- "acceptsPublisherPaidPlacements": {
- "description": "Select only sites that accept publisher paid placements.",
- "location": "query",
- "type": "boolean"
- },
- "adWordsSite": {
- "description": "Select only AdWords sites.",
- "location": "query",
- "type": "boolean"
- },
- "approved": {
- "description": "Select only approved sites.",
- "location": "query",
- "type": "boolean"
- },
- "campaignIds": {
- "description": "Select only sites with these campaign IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "directorySiteIds": {
- "description": "Select only sites with these directory site IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "ids": {
- "description": "Select only sites with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only sites with this subaccount ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "unmappedSite": {
- "description": "Select only sites that have not been mapped to a directory site.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "response": {
- "$ref": "SitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing site. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "PATCH",
- "id": "dfareporting.sites.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Site ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing site.",
- "flatPath": "userprofiles/{profileId}/sites",
- "httpMethod": "PUT",
- "id": "dfareporting.sites.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sites",
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories/{id}",
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "POST",
+ "id": "dfareporting.contentCategories.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "sizes": {
- "methods": {
- "get": {
- "description": "Gets one size by ID.",
- "flatPath": "userprofiles/{profileId}/sizes/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.sizes.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Size ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sizes/{id}",
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new size.",
- "flatPath": "userprofiles/{profileId}/sizes",
- "httpMethod": "POST",
- "id": "dfareporting.sizes.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/sizes",
- "request": {
- "$ref": "Size"
- },
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
- "flatPath": "userprofiles/{profileId}/sizes",
- "httpMethod": "GET",
- "id": "dfareporting.sizes.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "height": {
- "description": "Select only sizes with this height.",
- "format": "int32",
- "location": "query",
- "maximum": "32767",
- "minimum": "0",
- "type": "integer"
- },
- "iabStandard": {
- "description": "Select only IAB standard sizes.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only sizes with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "width": {
- "description": "Select only sizes with this width.",
- "format": "int32",
- "location": "query",
- "maximum": "32767",
- "minimum": "0",
- "type": "integer"
- }
- },
- "path": "userprofiles/{profileId}/sizes",
- "response": {
- "$ref": "SizesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only content categories with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
}
- },
- "subaccounts": {
- "methods": {
- "get": {
- "description": "Gets one subaccount by ID.",
- "flatPath": "userprofiles/{profileId}/subaccounts/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.subaccounts.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Subaccount ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts/{id}",
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new subaccount.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "POST",
- "id": "dfareporting.subaccounts.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "GET",
- "id": "dfareporting.subaccounts.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only subaccounts with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "response": {
- "$ref": "SubaccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing subaccount. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PATCH",
- "id": "dfareporting.subaccounts.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Subaccount ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing subaccount.",
- "flatPath": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PUT",
- "id": "dfareporting.subaccounts.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/subaccounts",
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "response": {
+ "$ref": "ContentCategoriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing content category. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.contentCategories.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ContentCategory ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "targetableRemarketingLists": {
- "methods": {
- "get": {
- "description": "Gets one remarketing list by ID.",
- "flatPath": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.targetableRemarketingLists.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Remarketing list ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "response": {
- "$ref": "TargetableRemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/targetableRemarketingLists",
- "httpMethod": "GET",
- "id": "dfareporting.targetableRemarketingLists.list",
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "parameters": {
- "active": {
- "description": "Select only active or only inactive targetable remarketing lists.",
- "location": "query",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Select only targetable remarketing lists targetable by these advertisers.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "name": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetableRemarketingLists",
- "response": {
- "$ref": "TargetableRemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing content category.",
+ "flatPath": "userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PUT",
+ "id": "dfareporting.contentCategories.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "targetingTemplates": {
- "methods": {
- "get": {
- "description": "Gets one targeting template by ID.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.targetingTemplates.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Targeting template ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates/{id}",
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new targeting template.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "POST",
- "id": "dfareporting.targetingTemplates.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "GET",
- "id": "dfareporting.targetingTemplates.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "advertiserId": {
- "description": "Select only targeting templates with this advertiser ID.",
- "format": "int64",
- "location": "query",
- "type": "string"
- },
- "ids": {
- "description": "Select only targeting templates with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "response": {
- "$ref": "TargetingTemplatesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing targeting template. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "PATCH",
- "id": "dfareporting.targetingTemplates.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "TargetingTemplate ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing targeting template.",
- "flatPath": "userprofiles/{profileId}/targetingTemplates",
- "httpMethod": "PUT",
- "id": "dfareporting.targetingTemplates.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/targetingTemplates",
- "request": {
- "$ref": "TargetingTemplate"
- },
- "response": {
- "$ref": "TargetingTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "conversions": {
+ "methods": {
+ "batchinsert": {
+ "description": "Inserts conversions.",
+ "flatPath": "userprofiles/{profileId}/conversions/batchinsert",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchinsert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userProfiles": {
- "methods": {
- "get": {
- "description": "Gets one user profile by ID.",
- "flatPath": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "id": "dfareporting.userProfiles.get",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "The user profile ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}",
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions",
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves list of user profiles for a user.",
- "flatPath": "userprofiles",
- "httpMethod": "GET",
- "id": "dfareporting.userProfiles.list",
- "parameterOrder": [],
- "parameters": {},
- "path": "userprofiles",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ddmconversions",
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/conversions/batchinsert",
+ "request": {
+ "$ref": "ConversionsBatchInsertRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchInsertResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ },
+ "batchupdate": {
+ "description": "Updates existing conversions.",
+ "flatPath": "userprofiles/{profileId}/conversions/batchupdate",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchupdate",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRolePermissionGroups": {
- "methods": {
- "get": {
- "description": "Gets one user role permission group by ID.",
- "flatPath": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissionGroups.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role permission group ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "response": {
- "$ref": "UserRolePermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of all supported user role permission groups.",
- "flatPath": "userprofiles/{profileId}/userRolePermissionGroups",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissionGroups.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissionGroups",
- "response": {
- "$ref": "UserRolePermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/conversions/batchupdate",
+ "request": {
+ "$ref": "ConversionsBatchUpdateRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchUpdateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ }
+ }
+ },
+ "countries": {
+ "methods": {
+ "get": {
+ "description": "Gets one country by ID.",
+ "flatPath": "userprofiles/{profileId}/countries/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Country DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRolePermissions": {
- "methods": {
- "get": {
- "description": "Gets one user role permission by ID.",
- "flatPath": "userprofiles/{profileId}/userRolePermissions/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissions.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role permission ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- "response": {
- "$ref": "UserRolePermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Gets a list of user role permissions, possibly filtered.",
- "flatPath": "userprofiles/{profileId}/userRolePermissions",
- "httpMethod": "GET",
- "id": "dfareporting.userRolePermissions.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "ids": {
- "description": "Select only user role permissions with these IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRolePermissions",
- "response": {
- "$ref": "UserRolePermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/countries/{dartId}",
+ "response": {
+ "$ref": "Country"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of countries.",
+ "flatPath": "userprofiles/{profileId}/countries",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- },
- "userRoles": {
- "methods": {
- "delete": {
- "description": "Deletes an existing user role.",
- "flatPath": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "DELETE",
- "id": "dfareporting.userRoles.delete",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "description": "Gets one user role by ID.",
- "flatPath": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.userRoles.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "User role ID.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "description": "Inserts a new user role.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "POST",
- "id": "dfareporting.userRoles.insert",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "GET",
- "id": "dfareporting.userRoles.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "accountUserRoleOnly": {
- "description": "Select only account level user roles not associated with any specific subaccount.",
- "location": "query",
- "type": "boolean"
- },
- "ids": {
- "description": "Select only user roles with the specified IDs.",
- "format": "int64",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "default": "1000",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query",
- "maximum": "1000",
- "minimum": "0",
- "type": "integer"
- },
- "pageToken": {
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query",
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "searchString": {
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- "location": "query",
- "type": "string"
- },
- "sortField": {
- "default": "ID",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "sortOrder": {
- "default": "ASCENDING",
- "description": "Order of sorted results.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query",
- "type": "string"
- },
- "subaccountId": {
- "description": "Select only user roles that belong to this subaccount.",
- "format": "int64",
- "location": "query",
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "response": {
- "$ref": "UserRolesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "description": "Updates an existing user role. This method supports patch semantics.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PATCH",
- "id": "dfareporting.userRoles.patch",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "UserRole ID.",
- "format": "int64",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "description": "Updates an existing user role.",
- "flatPath": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PUT",
- "id": "dfareporting.userRoles.update",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/userRoles",
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "path": "userprofiles/{profileId}/countries",
+ "response": {
+ "$ref": "CountriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeAssets": {
+ "methods": {
+ "insert": {
+ "description": "Inserts a new creative asset.",
+ "flatPath": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeAssets.insert",
+ "mediaUpload": {
+ "accept": [
+ "*/*"
+ ],
+ "maxSize": "1073741824",
+ "protocols": {
+ "simple": {
+ "multipart": true,
+ "path": "/upload/dfareporting/v3.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
+ }
}
- },
- "videoFormats": {
- "methods": {
- "get": {
- "description": "Gets one video format by ID.",
- "flatPath": "userprofiles/{profileId}/videoFormats/{id}",
- "httpMethod": "GET",
- "id": "dfareporting.videoFormats.get",
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Video format ID.",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/videoFormats/{id}",
- "response": {
- "$ref": "VideoFormat"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "description": "Lists available video formats.",
- "flatPath": "userprofiles/{profileId}/videoFormats",
- "httpMethod": "GET",
- "id": "dfareporting.videoFormats.list",
- "parameterOrder": [
- "profileId"
- ],
- "parameters": {
- "profileId": {
- "description": "User profile ID associated with this request.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "userprofiles/{profileId}/videoFormats",
- "response": {
- "$ref": "VideoFormatsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
+ },
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "request": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "response": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ],
+ "supportsMediaUpload": true
}
+ }
},
- "revision": "20210210",
- "rootUrl": "https://dfareporting.googleapis.com/",
- "schemas": {
- "Account": {
- "description": "Contains properties of a Campaign Manager account.",
- "id": "Account",
- "properties": {
- "accountPermissionIds": {
- "description": "Account permissions assigned to this account.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "accountProfile": {
- "description": "Profile for this account. This is a read-only field that can be left blank.",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "active": {
- "description": "Whether this account is active.",
- "type": "boolean"
- },
- "activeAdsLimitTier": {
- "description": "Maximum number of active ads allowed for this account.",
- "enum": [
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K",
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_500K",
- "ACTIVE_ADS_TIER_750K",
- "ACTIVE_ADS_TIER_1M"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "activeViewOptOut": {
- "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.",
- "type": "boolean"
- },
- "availablePermissionIds": {
- "description": "User role permissions available to the user roles of this account.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "countryId": {
- "description": "ID of the country associated with this account.",
- "format": "int64",
- "type": "string"
- },
- "currencyId": {
- "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ",
- "format": "int64",
- "type": "string"
- },
- "defaultCreativeSizeId": {
- "description": "Default placement dimensions for this account.",
- "format": "int64",
- "type": "string"
- },
- "description": {
- "description": "Description of this account.",
- "type": "string"
- },
- "id": {
- "description": "ID of this account. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
- "type": "string"
- },
- "locale": {
- "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
- "type": "string"
- },
- "maximumImageSize": {
- "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.",
- "type": "string"
- },
- "nielsenOcrEnabled": {
- "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.",
- "type": "boolean"
- },
- "reportsConfiguration": {
- "$ref": "ReportsConfiguration",
- "description": "Reporting configuration of this account."
- },
- "shareReportsWithTwitter": {
- "description": "Share Path to Conversion reports with Twitter.",
- "type": "boolean"
- },
- "teaserSizeLimit": {
- "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
- "format": "int64",
- "type": "string"
- }
+ "creativeFieldValues": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFieldValues.delete",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountActiveAdSummary": {
- "description": "Gets a summary of active ads in an account.",
- "id": "AccountActiveAdSummary",
- "properties": {
- "accountId": {
- "description": "ID of the account.",
- "format": "int64",
- "type": "string"
- },
- "activeAds": {
- "description": "Ads that have been activated for the account",
- "format": "int64",
- "type": "string"
- },
- "activeAdsLimitTier": {
- "description": "Maximum number of active ads allowed for the account.",
- "enum": [
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K",
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_500K",
- "ACTIVE_ADS_TIER_750K",
- "ACTIVE_ADS_TIER_1M"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "availableAds": {
- "description": "Ads that can be activated for the account.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
- "type": "string"
- }
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermission": {
- "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
- "id": "AccountPermission",
- "properties": {
- "accountProfiles": {
- "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
- "items": {
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this account permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
- "type": "string"
- },
- "level": {
- "description": "Administrative level required to enable this account permission.",
- "enum": [
- "USER",
- "ADMINISTRATOR"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of this account permission.",
- "type": "string"
- },
- "permissionGroupId": {
- "description": "Permission group of this account permission.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field value by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.get",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionGroup": {
- "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
- "id": "AccountPermissionGroup",
- "properties": {
- "id": {
- "description": "ID of this account permission group.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this account permission group.",
- "type": "string"
- }
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionGroupsListResponse": {
- "description": "Account Permission Group List Response",
- "id": "AccountPermissionGroupsListResponse",
- "properties": {
- "accountPermissionGroups": {
- "description": "Account permission group collection.",
- "items": {
- "$ref": "AccountPermissionGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFieldValues.insert",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountPermissionsListResponse": {
- "description": "Account Permission List Response",
- "id": "AccountPermissionsListResponse",
- "properties": {
- "accountPermissions": {
- "description": "Account permission collection.",
- "items": {
- "$ref": "AccountPermission"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.list",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountUserProfile": {
- "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
- "id": "AccountUserProfile",
- "properties": {
- "accountId": {
- "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.",
- "type": "boolean"
- },
- "advertiserFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which advertisers are visible to the user profile."
- },
- "campaignFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which campaigns are visible to the user profile."
- },
- "comments": {
- "description": "Comments for this user profile.",
- "type": "string"
- },
- "email": {
- "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.",
- "type": "string"
- },
- "id": {
- "description": "ID of the user profile. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
- "type": "string"
- },
- "locale": {
- "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
- "type": "string"
- },
- "name": {
- "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".",
- "type": "string"
- },
- "siteFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which sites are visible to the user profile."
- },
- "subaccountId": {
- "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "traffickerType": {
- "description": "Trafficker type of this user profile. This is a read-only field.",
- "enum": [
- "INTERNAL_NON_TRAFFICKER",
- "INTERNAL_TRAFFICKER",
- "EXTERNAL_TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "userAccessType": {
- "description": "User type of the user profile. This is a read-only field that can be left blank.",
- "enum": [
- "NORMAL_USER",
- "SUPER_USER",
- "INTERNAL_ADMINISTRATOR",
- "READ_ONLY_SUPER_USER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "userRoleFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which user roles are visible to the user profile."
- },
- "userRoleId": {
- "description": "User role ID of the user profile. This is a required field.",
- "format": "int64",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative field values with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AccountUserProfilesListResponse": {
- "description": "Account User Profile List Response",
- "id": "AccountUserProfilesListResponse",
- "properties": {
- "accountUserProfiles": {
- "description": "Account user profile collection.",
- "items": {
- "$ref": "AccountUserProfile"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "AccountsListResponse": {
- "description": "Account List Response",
- "id": "AccountsListResponse",
- "properties": {
- "accounts": {
- "description": "Account collection.",
- "items": {
- "$ref": "Account"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Activities": {
- "description": "Represents an activity group.",
- "id": "Activities",
- "properties": {
- "filters": {
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "type": "string"
- },
- "metricNames": {
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Ad": {
- "description": "Contains properties of a Campaign Manager ad.",
- "id": "Ad",
- "properties": {
- "accountId": {
- "description": "Account ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this ad is active. When true, archived must be false.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Advertiser ID of this ad. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this ad is archived. When true, active must be false.",
- "type": "boolean"
- },
- "audienceSegmentId": {
- "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64",
- "type": "string"
- },
- "campaignId": {
- "description": "Campaign ID of this ad. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
- },
- "comments": {
- "description": "Comments for this ad.",
- "type": "string"
- },
- "compatibility": {
- "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this ad. This is a read-only field."
- },
- "creativeGroupAssignments": {
- "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- },
- "type": "array"
- },
- "creativeRotation": {
- "$ref": "CreativeRotation",
- "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Default click-through event tag properties for this ad."
- },
- "deliverySchedule": {
- "$ref": "DeliverySchedule",
- "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
- },
- "dynamicClickTracker": {
- "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.",
- "type": "boolean"
- },
- "endTime": {
- "format": "date-time",
- "type": "string"
- },
- "eventTagOverrides": {
- "description": "Event tag overrides for this ad.",
- "items": {
- "$ref": "EventTagOverride"
- },
- "type": "array"
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "id": {
- "description": "ID of this ad. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
- "type": "string"
- },
- "languageTargeting": {
- "$ref": "LanguageTargeting",
- "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this ad. This is a read-only field."
- },
- "name": {
- "description": "Name of this ad. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "placementAssignments": {
- "description": "Placement assignments for this ad.",
- "items": {
- "$ref": "PlacementAssignment"
- },
- "type": "array"
- },
- "remarketingListExpression": {
- "$ref": "ListTargetingExpression",
- "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "size": {
- "$ref": "Size",
- "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
- },
- "sslCompliant": {
- "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "startTime": {
- "format": "date-time",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "targetingTemplateId": {
- "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64",
- "type": "string"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "type": {
- "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
- "enum": [
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_TRACKING",
- "AD_SERVING_BRAND_SAFE_AD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "AdBlockingConfiguration": {
- "description": "Campaign ad blocking settings.",
- "id": "AdBlockingConfiguration",
- "properties": {
- "clickThroughUrl": {
- "description": "Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.",
- "type": "string"
- },
- "creativeBundleId": {
- "description": "ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.",
- "format": "int64",
- "type": "string"
- },
- "enabled": {
- "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.",
- "type": "boolean"
- },
- "overrideClickThroughUrl": {
- "description": "Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.",
- "type": "boolean"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "VALUE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "AdSlot": {
- "description": "Ad Slot",
- "id": "AdSlot",
- "properties": {
- "comment": {
- "description": "Comment for this ad slot.",
- "type": "string"
- },
- "compatibility": {
- "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "height": {
- "description": "Height of this ad slot.",
- "format": "int64",
- "type": "string"
- },
- "linkedPlacementId": {
- "description": "ID of the placement from an external platform that is linked to this ad slot.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this ad slot.",
- "type": "string"
- },
- "paymentSourceType": {
- "description": "Payment source type of this ad slot.",
- "enum": [
- "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
- "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "primary": {
- "description": "Primary ad slot of a roadblock inventory item.",
- "type": "boolean"
- },
- "width": {
- "description": "Width of this ad slot.",
- "format": "int64",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "response": {
+ "$ref": "CreativeFieldValuesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field value. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFieldValues.patch",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdsListResponse": {
- "description": "Ad List Response",
- "id": "AdsListResponse",
- "properties": {
- "ads": {
- "description": "Ad collection.",
- "items": {
- "$ref": "Ad"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "id": {
+ "description": "CreativeFieldValue ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Advertiser": {
- "description": "Contains properties of a Campaign Manager advertiser.",
- "id": "Advertiser",
- "properties": {
- "accountId": {
- "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserGroupId": {
- "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
- "format": "int64",
- "type": "string"
- },
- "clickThroughUrlSuffix": {
- "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
- "type": "string"
- },
- "defaultClickThroughEventTagId": {
- "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
- "format": "int64",
- "type": "string"
- },
- "defaultEmail": {
- "description": "Default email address used in sender field for tag emails.",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this advertiser. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
- "type": "string"
- },
- "originalFloodlightConfigurationId": {
- "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "description": "Status of this advertiser.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "suspended": {
- "description": "Suspension status of this advertiser.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field value.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFieldValues.update",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserGroup": {
- "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
- "id": "AdvertiserGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeFields": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFields.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserGroupsListResponse": {
- "description": "Advertiser Group List Response",
- "id": "AdvertiserGroupsListResponse",
- "properties": {
- "advertiserGroups": {
- "description": "Advertiser group collection.",
- "items": {
- "$ref": "AdvertiserGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertiserLandingPagesListResponse": {
- "description": "Landing Page List Response",
- "id": "AdvertiserLandingPagesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
- "type": "string"
- },
- "landingPages": {
- "description": "Landing page collection",
- "items": {
- "$ref": "LandingPage"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields/{id}",
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFields.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative fields that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AdvertisersListResponse": {
- "description": "Advertiser List Response",
- "id": "AdvertisersListResponse",
- "properties": {
- "advertisers": {
- "description": "Advertiser collection.",
- "items": {
- "$ref": "Advertiser"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative fields with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "AudienceSegment": {
- "description": "Audience Segment.",
- "id": "AudienceSegment",
- "properties": {
- "allocation": {
- "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "ID of this audience segment. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "AudienceSegmentGroup": {
- "description": "Audience Segment Group.",
- "id": "AudienceSegmentGroup",
- "properties": {
- "audienceSegments": {
- "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
- "items": {
- "$ref": "AudienceSegment"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Browser": {
- "description": "Contains information about a browser that can be targeted by ads.",
- "id": "Browser",
- "properties": {
- "browserVersionId": {
- "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this browser. This is the ID used when generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
- "type": "string"
- },
- "majorVersion": {
- "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
- "type": "string"
- },
- "minorVersion": {
- "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
- "type": "string"
- },
- "name": {
- "description": "Name of this browser.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "BrowsersListResponse": {
- "description": "Browser List Response",
- "id": "BrowsersListResponse",
- "properties": {
- "browsers": {
- "description": "Browser collection.",
- "items": {
- "$ref": "Browser"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Campaign": {
- "description": "Contains properties of a Campaign Manager campaign.",
- "id": "Campaign",
- "properties": {
- "accountId": {
- "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "adBlockingConfiguration": {
- "$ref": "AdBlockingConfiguration",
- "description": "Ad blocking settings for this campaign."
- },
- "additionalCreativeOptimizationConfigurations": {
- "description": "Additional creative optimization configurations for the campaign.",
- "items": {
- "$ref": "CreativeOptimizationConfiguration"
- },
- "type": "array"
- },
- "advertiserGroupId": {
- "description": "Advertiser group ID of the associated advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this campaign. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this campaign has been archived.",
- "type": "boolean"
- },
- "audienceSegmentGroups": {
- "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
- "items": {
- "$ref": "AudienceSegmentGroup"
- },
- "type": "array"
- },
- "billingInvoiceCode": {
- "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.",
- "type": "string"
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix override properties for this campaign."
- },
- "comment": {
- "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this campaign. This is a read-only field."
- },
- "creativeGroupIds": {
- "description": "List of creative group IDs that are assigned to the campaign.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "creativeOptimizationConfiguration": {
- "$ref": "CreativeOptimizationConfiguration",
- "description": "Creative optimization configuration for the campaign."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Click-through event tag ID override properties for this campaign."
- },
- "defaultLandingPageId": {
- "description": "The default landing page ID for this campaign.",
- "format": "int64",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "eventTagOverrides": {
- "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
- "items": {
- "$ref": "EventTagOverride"
- },
- "type": "array"
- },
- "externalId": {
- "description": "External ID for this campaign.",
- "type": "string"
- },
- "id": {
- "description": "ID of this campaign. This is a read-only auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this campaign. This is a read-only field."
- },
- "name": {
- "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.",
- "type": "string"
- },
- "nielsenOcrEnabled": {
- "description": "Whether Nielsen reports are enabled for this campaign.",
- "type": "boolean"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "traffickerEmails": {
- "description": "Campaign trafficker contact emails.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CampaignCreativeAssociation": {
- "description": "Identifies a creative which has been associated with a given campaign.",
- "id": "CampaignCreativeAssociation",
- "properties": {
- "creativeId": {
- "description": "ID of the creative associated with the campaign. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "response": {
+ "$ref": "CreativeFieldsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFields.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CampaignCreativeAssociationsListResponse": {
- "description": "Campaign Creative Association List Response",
- "id": "CampaignCreativeAssociationsListResponse",
- "properties": {
- "campaignCreativeAssociations": {
- "description": "Campaign creative association collection",
- "items": {
- "$ref": "CampaignCreativeAssociation"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field.",
+ "flatPath": "userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFields.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative group by ID.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CampaignManagerIds": {
- "description": "Campaign Manager IDs related to the custom event.",
- "id": "CampaignManagerIds",
- "properties": {
- "adId": {
- "description": "Ad ID for Campaign Manager.",
- "format": "int64",
- "type": "string"
- },
- "campaignId": {
- "description": "Campaign ID for Campaign Manager.",
- "format": "int64",
- "type": "string"
- },
- "creativeId": {
- "description": "Creative ID for Campaign Manager.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignManagerIds\".",
- "type": "string"
- },
- "placementId": {
- "description": "Placement ID for Campaign Manager.",
- "format": "int64",
- "type": "string"
- },
- "siteId": {
- "description": "Site ID for Campaign Manager.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups/{id}",
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative group.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CampaignsListResponse": {
- "description": "Campaign List Response",
- "id": "CampaignsListResponse",
- "properties": {
- "campaigns": {
- "description": "Campaign collection.",
- "items": {
- "$ref": "Campaign"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "groupNumber": {
+ "description": "Select only creative groups that belong to this subgroup.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "2",
+ "minimum": "1",
+ "type": "integer"
},
- "type": "object"
- },
- "ChangeLog": {
- "description": "Describes a change that a user has made to a resource.",
- "id": "ChangeLog",
- "properties": {
- "accountId": {
- "description": "Account ID of the modified object.",
- "format": "int64",
- "type": "string"
- },
- "action": {
- "description": "Action which caused the change.",
- "type": "string"
- },
- "changeTime": {
- "format": "date-time",
- "type": "string"
- },
- "fieldName": {
- "description": "Field name of the object which changed.",
- "type": "string"
- },
- "id": {
- "description": "ID of this change log.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
- "type": "string"
- },
- "newValue": {
- "description": "New value of the object field.",
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
- "format": "int64",
- "type": "string"
- },
- "objectType": {
- "description": "Object type of the change log.",
- "type": "string"
- },
- "oldValue": {
- "description": "Old value of the object field.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of the modified object.",
- "format": "int64",
- "type": "string"
- },
- "transactionId": {
- "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
- "format": "int64",
- "type": "string"
- },
- "userProfileId": {
- "description": "ID of the user who modified the object.",
- "format": "int64",
- "type": "string"
- },
- "userProfileName": {
- "description": "User profile name of the user who modified the object.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChangeLogsListResponse": {
- "description": "Change Log List Response",
- "id": "ChangeLogsListResponse",
- "properties": {
- "changeLogs": {
- "description": "Change log collection.",
- "items": {
- "$ref": "ChangeLog"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creative groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ChannelGrouping": {
- "description": "Represents a DfaReporting channel grouping.",
- "id": "ChannelGrouping",
- "properties": {
- "fallbackName": {
- "description": "ChannelGrouping fallback name.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#channelGrouping.",
- "type": "string"
- },
- "name": {
- "description": "ChannelGrouping name.",
- "type": "string"
- },
- "rules": {
- "description": "The rules contained within this channel grouping.",
- "items": {
- "$ref": "ChannelGroupingRule"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "ChannelGroupingRule": {
- "description": "Represents a DfaReporting channel grouping rule.",
- "id": "ChannelGroupingRule",
- "properties": {
- "disjunctiveMatchStatements": {
- "description": "The disjunctive match statements contained within this rule.",
- "items": {
- "$ref": "DisjunctiveMatchStatement"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#channelGroupingRule.",
- "type": "string"
- },
- "name": {
- "description": "Rule name.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CitiesListResponse": {
- "description": "City List Response",
- "id": "CitiesListResponse",
- "properties": {
- "cities": {
- "description": "City collection.",
- "items": {
- "$ref": "City"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "City": {
- "description": "Contains information about a city that can be targeted by ads.",
- "id": "City",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this city belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this city belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
- "type": "string"
- },
- "metroCode": {
- "description": "Metro region code of the metro region (DMA) to which this city belongs.",
- "type": "string"
- },
- "metroDmaId": {
- "description": "ID of the metro region (DMA) to which this city belongs.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this city.",
- "type": "string"
- },
- "regionCode": {
- "description": "Region code of the region to which this city belongs.",
- "type": "string"
- },
- "regionDartId": {
- "description": "DART ID of the region to which this city belongs.",
- "format": "int64",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ClickTag": {
- "description": "Creative Click Tag.",
- "id": "ClickTag",
- "properties": {
- "clickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Parameter value for the specified click tag. This field contains a click-through url."
- },
- "eventName": {
- "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "string"
- },
- "name": {
- "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ClickThroughUrl": {
- "description": "Click-through URL",
- "id": "ClickThroughUrl",
- "properties": {
- "computedClickThroughUrl": {
- "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
- "type": "string"
- },
- "customClickThroughUrl": {
- "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
- "type": "string"
- },
- "defaultLandingPage": {
- "description": "Whether the campaign default landing page is used.",
- "type": "boolean"
- },
- "landingPageId": {
- "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
- "format": "int64",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "response": {
+ "$ref": "CreativeGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ClickThroughUrlSuffixProperties": {
- "description": "Click Through URL Suffix settings.",
- "id": "ClickThroughUrlSuffixProperties",
- "properties": {
- "clickThroughUrlSuffix": {
- "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
- "type": "string"
- },
- "overrideInheritedSuffix": {
- "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative group.",
+ "flatPath": "userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative by ID.",
+ "flatPath": "userprofiles/{profileId}/creatives/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CompanionClickThroughOverride": {
- "description": "Companion Click-through override.",
- "id": "CompanionClickThroughOverride",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this companion click-through override."
- },
- "creativeId": {
- "description": "ID of the creative for this companion click-through override.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives/{id}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "POST",
+ "id": "dfareporting.creatives.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CompanionSetting": {
- "description": "Companion Settings",
- "id": "CompanionSetting",
- "properties": {
- "companionsDisabled": {
- "description": "Whether companions are disabled for this placement.",
- "type": "boolean"
- },
- "enabledSizes": {
- "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "imageOnly": {
- "description": "Whether to serve only static images as companions.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
- "type": "string"
- }
+ "advertiserId": {
+ "description": "Select only creatives with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CompatibleFields": {
- "description": "Represents a response to the queryCompatibleFields method.",
- "id": "CompatibleFields",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "type": "string"
- },
- "pathAttributionReportCompatibleFields": {
- "$ref": "PathReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_ATTRIBUTION\"."
- },
- "pathReportCompatibleFields": {
- "$ref": "PathReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH\"."
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
+ "archived": {
+ "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "ConnectionType": {
- "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
- "id": "ConnectionType",
- "properties": {
- "id": {
- "description": "ID of this connection type.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this connection type.",
- "type": "string"
- }
+ "campaignId": {
+ "description": "Select only creatives with this campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ConnectionTypesListResponse": {
- "description": "Connection Type List Response",
- "id": "ConnectionTypesListResponse",
- "properties": {
- "connectionTypes": {
- "description": "Collection of connection types such as broadband and mobile.",
- "items": {
- "$ref": "ConnectionType"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
- "type": "string"
- }
+ "companionCreativeIds": {
+ "description": "Select only in-stream video creatives with these companion IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ContentCategoriesListResponse": {
- "description": "Content Category List Response",
- "id": "ContentCategoriesListResponse",
- "properties": {
- "contentCategories": {
- "description": "Content category collection.",
- "items": {
- "$ref": "ContentCategory"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "creativeFieldIds": {
+ "description": "Select only creatives with these creative field IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ContentCategory": {
- "description": "Organizes placements according to the contents of their associated webpages.",
- "id": "ContentCategory",
- "properties": {
- "accountId": {
- "description": "Account ID of this content category. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this content category. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only creatives with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "Conversion": {
- "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
- "id": "Conversion",
- "properties": {
- "childDirectedTreatment": {
- "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
- "type": "boolean"
- },
- "customVariables": {
- "description": "Custom floodlight variables.",
- "items": {
- "$ref": "CustomFloodlightVariable"
- },
- "type": "array"
- },
- "dclid": {
- "description": "The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
- "type": "string"
- },
- "encryptedUserId": {
- "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.",
- "type": "string"
- },
- "encryptedUserIdCandidates": {
- "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "floodlightActivityId": {
- "description": "Floodlight Activity ID of this conversion. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight Configuration ID of this conversion. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "gclid": {
- "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
- "type": "string"
- },
- "limitAdTracking": {
- "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
- "type": "boolean"
- },
- "matchId": {
- "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.",
- "type": "string"
- },
- "mobileDeviceId": {
- "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.",
- "type": "string"
- },
- "nonPersonalizedAd": {
- "description": "Whether the conversion was for a non personalized ad.",
- "type": "boolean"
- },
- "ordinal": {
- "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity of the conversion.",
- "format": "int64",
- "type": "string"
- },
- "timestampMicros": {
- "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "treatmentForUnderage": {
- "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
- "type": "boolean"
- },
- "value": {
- "description": "The value of the conversion.",
- "format": "double",
- "type": "number"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "ConversionError": {
- "description": "The error code and description for a conversion that failed to insert or update.",
- "id": "ConversionError",
- "properties": {
- "code": {
- "description": "The error code.",
- "enum": [
- "INVALID_ARGUMENT",
- "INTERNAL",
- "PERMISSION_DENIED",
- "NOT_FOUND"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
- "type": "string"
- },
- "message": {
- "description": "A description of the error.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ConversionStatus": {
- "description": "The original conversion that was inserted or updated and whether there were any errors.",
- "id": "ConversionStatus",
- "properties": {
- "conversion": {
- "$ref": "Conversion",
- "description": "The original conversion that was inserted or updated."
- },
- "errors": {
- "description": "A list of errors related to this conversion.",
- "items": {
- "$ref": "ConversionError"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchInsertRequest": {
- "description": "Insert Conversions Request.",
- "id": "ConversionsBatchInsertRequest",
- "properties": {
- "conversions": {
- "description": "The set of conversions to insert.",
- "items": {
- "$ref": "Conversion"
- },
- "type": "array"
- },
- "encryptionInfo": {
- "$ref": "EncryptionInfo",
- "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
- "type": "string"
- }
+ "renderingIds": {
+ "description": "Select only creatives with these rendering IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchInsertResponse": {
- "description": "Insert Conversions Response.",
- "id": "ConversionsBatchInsertResponse",
- "properties": {
- "hasFailures": {
- "description": "Indicates that some or all conversions failed to insert.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
- "type": "string"
- },
- "status": {
- "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
- "items": {
- "$ref": "ConversionStatus"
- },
- "type": "array"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchUpdateRequest": {
- "description": "Update Conversions Request.",
- "id": "ConversionsBatchUpdateRequest",
- "properties": {
- "conversions": {
- "description": "The set of conversions to update.",
- "items": {
- "$ref": "Conversion"
- },
- "type": "array"
- },
- "encryptionInfo": {
- "$ref": "EncryptionInfo",
- "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
- "type": "string"
- }
+ "sizeIds": {
+ "description": "Select only creatives with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ConversionsBatchUpdateResponse": {
- "description": "Update Conversions Response.",
- "id": "ConversionsBatchUpdateResponse",
- "properties": {
- "hasFailures": {
- "description": "Indicates that some or all conversions failed to update.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
- "type": "string"
- },
- "status": {
- "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.",
- "items": {
- "$ref": "ConversionStatus"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CountriesListResponse": {
- "description": "Country List Response",
- "id": "CountriesListResponse",
- "properties": {
- "countries": {
- "description": "Country collection.",
- "items": {
- "$ref": "Country"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Country": {
- "description": "Contains information about a country that can be targeted by ads.",
- "id": "Country",
- "properties": {
- "countryCode": {
- "description": "Country code.",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this country.",
- "type": "string"
- },
- "sslEnabled": {
- "description": "Whether ad serving supports secure servers in this country.",
- "type": "boolean"
- }
+ "studioCreativeId": {
+ "description": "Select only creatives corresponding to this Studio creative ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Creative": {
- "description": "Contains properties of a Creative.",
- "id": "Creative",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether the creative is active. Applicable to all creative types.",
- "type": "boolean"
- },
- "adParameters": {
- "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "type": "string"
- },
- "adTagKeys": {
- "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "allowScriptAccess": {
- "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
- "type": "boolean"
- },
- "archived": {
- "description": "Whether the creative is archived. Applicable to all creative types.",
- "type": "boolean"
- },
- "artworkType": {
- "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "authoringSource": {
- "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
- "enum": [
- "CREATIVE_AUTHORING_SOURCE_DCM",
- "CREATIVE_AUTHORING_SOURCE_DBM",
- "CREATIVE_AUTHORING_SOURCE_STUDIO",
- "CREATIVE_AUTHORING_SOURCE_GWD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "authoringTool": {
- "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "enum": [
- "NINJA",
- "SWIFFY"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "autoAdvanceImages": {
- "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
- "type": "boolean"
- },
- "backgroundColor": {
- "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
- "type": "string"
- },
- "backupImageClickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE."
- },
- "backupImageFeatures": {
- "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "backupImageReportingLabel": {
- "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "string"
- },
- "backupImageTargetWindow": {
- "$ref": "TargetWindow",
- "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
- },
- "clickTags": {
- "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "$ref": "ClickTag"
- },
- "type": "array"
- },
- "commercialId": {
- "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.",
- "type": "string"
- },
- "companionCreatives": {
- "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "compatibility": {
- "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ",
- "items": {
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "convertFlashToHtml5": {
- "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "boolean"
- },
- "counterCustomEvents": {
- "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "creativeAssetSelection": {
- "$ref": "CreativeAssetSelection",
- "description": "Required if dynamicAssetSelection is true."
- },
- "creativeAssets": {
- "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
- "items": {
- "$ref": "CreativeAsset"
- },
- "type": "array"
- },
- "creativeFieldAssignments": {
- "description": "Creative field assignments for this creative. Applicable to all creative types.",
- "items": {
- "$ref": "CreativeFieldAssignment"
- },
- "type": "array"
- },
- "customKeyValues": {
- "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dynamicAssetSelection": {
- "description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.",
- "type": "boolean"
- },
- "exitCustomEvents": {
- "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "fsCommand": {
- "$ref": "FsCommand",
- "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
- },
- "htmlCode": {
- "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
- "type": "string"
- },
- "htmlCodeLocked": {
- "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
- },
- "latestTraffickedCreativeId": {
- "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "mediaDescription": {
- "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
- "type": "string"
- },
- "mediaDuration": {
- "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "name": {
- "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.",
- "type": "string"
- },
- "obaIcon": {
- "$ref": "ObaIcon",
- "description": "Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO."
- },
- "overrideCss": {
- "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO."
- },
- "redirectUrl": {
- "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT",
- "type": "string"
- },
- "renderingId": {
- "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "renderingIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "requiredFlashPluginVersion": {
- "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "type": "string"
- },
- "requiredFlashVersion": {
- "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "format": "int32",
- "type": "integer"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO."
- },
- "skippable": {
- "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.",
- "type": "boolean"
- },
- "sslCompliant": {
- "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.",
- "type": "boolean"
- },
- "sslOverride": {
- "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
- "type": "boolean"
- },
- "studioAdvertiserId": {
- "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "studioCreativeId": {
- "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "studioTraffickedCreativeId": {
- "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64",
- "type": "string"
- },
- "thirdPartyBackupImageImpressionsUrl": {
- "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "thirdPartyRichMediaImpressionsUrl": {
- "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "string"
- },
- "thirdPartyUrls": {
- "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
- "items": {
- "$ref": "ThirdPartyTrackingUrl"
- },
- "type": "array"
- },
- "timerCustomEvents": {
- "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "totalFileSize": {
- "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.",
- "enum": [
- "IMAGE",
- "DISPLAY_REDIRECT",
- "CUSTOM_DISPLAY",
- "INTERNAL_REDIRECT",
- "CUSTOM_DISPLAY_INTERSTITIAL",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "TRACKING_TEXT",
- "RICH_MEDIA_DISPLAY_BANNER",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_DISPLAY_EXPANDING",
- "RICH_MEDIA_DISPLAY_INTERSTITIAL",
- "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
- "RICH_MEDIA_MOBILE_IN_APP",
- "FLASH_INPAGE",
- "INSTREAM_VIDEO",
- "VPAID_LINEAR_VIDEO",
- "VPAID_NON_LINEAR_VIDEO",
- "INSTREAM_VIDEO_REDIRECT",
- "RICH_MEDIA_PEEL_DOWN",
- "HTML5_BANNER",
- "DISPLAY",
- "DISPLAY_IMAGE_GALLERY",
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "INSTREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "universalAdId": {
- "$ref": "UniversalAdId",
- "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
- },
- "version": {
- "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
- "format": "int32",
- "type": "integer"
- }
+ "types": {
+ "description": "Select only creatives with these creative types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "response": {
+ "$ref": "CreativesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creatives.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAsset": {
- "description": "Creative Asset.",
- "id": "CreativeAsset",
- "properties": {
- "actionScript3": {
- "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "type": "boolean"
- },
- "active": {
- "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "type": "boolean"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "alignment": {
- "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .",
- "enum": [
- "ALIGNMENT_TOP",
- "ALIGNMENT_RIGHT",
- "ALIGNMENT_BOTTOM",
- "ALIGNMENT_LEFT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "artworkType": {
- "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "audioBitRate": {
- "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "audioSampleRate": {
- "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "backupImageExit": {
- "$ref": "CreativeCustomEvent",
- "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
- },
- "bitRate": {
- "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "int32",
- "type": "integer"
- },
- "childAssetType": {
- "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "enum": [
- "CHILD_ASSET_TYPE_FLASH",
- "CHILD_ASSET_TYPE_VIDEO",
- "CHILD_ASSET_TYPE_IMAGE",
- "CHILD_ASSET_TYPE_DATA"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "collapsedSize": {
- "$ref": "Size",
- "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "companionCreativeIds": {
- "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "customStartTimeValue": {
- "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
- "format": "int32",
- "type": "integer"
- },
- "detectedFeatures": {
- "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "displayType": {
- "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DISPLAY_TYPE_INPAGE",
- "ASSET_DISPLAY_TYPE_FLOATING",
- "ASSET_DISPLAY_TYPE_OVERLAY",
- "ASSET_DISPLAY_TYPE_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
- "ASSET_DISPLAY_TYPE_PEEL_DOWN",
- "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
- "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
- "ASSET_DISPLAY_TYPE_BACKDROP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "duration": {
- "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- },
- "durationType": {
- "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DURATION_TYPE_AUTO",
- "ASSET_DURATION_TYPE_NONE",
- "ASSET_DURATION_TYPE_CUSTOM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "expandedDimension": {
- "$ref": "Size",
- "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "fileSize": {
- "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64",
- "type": "string"
- },
- "flashVersion": {
- "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
- "format": "int32",
- "type": "integer"
- },
- "frameRate": {
- "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "hideFlashObjects": {
- "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "hideSelectionBoxes": {
- "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "horizontallyLocked": {
- "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "id": {
- "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
- },
- "mediaDuration": {
- "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "format": "float",
- "type": "number"
- },
- "mimeType": {
- "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "orientation": {
- "description": "Orientation of video asset. This is a read-only, auto-generated field.",
- "enum": [
- "LANDSCAPE",
- "PORTRAIT",
- "SQUARE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "originalBackup": {
- "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "politeLoad": {
- "description": "Whether this asset is used as a polite load asset.",
- "type": "boolean"
- },
- "position": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "positionLeftUnit": {
- "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "positionTopUnit": {
- "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "progressiveServingUrl": {
- "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "pushdown": {
- "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
- "type": "boolean"
- },
- "pushdownDuration": {
- "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
- "format": "float",
- "type": "number"
- },
- "role": {
- "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
- "enum": [
- "PRIMARY",
- "BACKUP_IMAGE",
- "ADDITIONAL_IMAGE",
- "ADDITIONAL_FLASH",
- "PARENT_VIDEO",
- "TRANSCODED_VIDEO",
- "OTHER",
- "ALTERNATE_VIDEO",
- "PARENT_AUDIO",
- "TRANSCODED_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
- },
- "sslCompliant": {
- "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "type": "boolean"
- },
- "startTimeType": {
- "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_START_TIME_TYPE_NONE",
- "ASSET_START_TIME_TYPE_CUSTOM"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "streamingServingUrl": {
- "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "type": "string"
- },
- "transparency": {
- "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.",
- "type": "boolean"
- },
- "verticallyLocked": {
- "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "type": "boolean"
- },
- "windowMode": {
- "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
- "enum": [
- "OPAQUE",
- "WINDOW",
- "TRANSPARENT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "zIndex": {
- "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "zipFilename": {
- "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "type": "string"
- },
- "zipFilesize": {
- "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative.",
+ "flatPath": "userprofiles/{profileId}/creatives",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creatives.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "customEvents": {
+ "methods": {
+ "batchinsert": {
+ "description": "Inserts custom events.",
+ "flatPath": "userprofiles/{profileId}/customEvents/batchinsert",
+ "httpMethod": "POST",
+ "id": "dfareporting.customEvents.batchinsert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/customEvents/batchinsert",
+ "request": {
+ "$ref": "CustomEventsBatchInsertRequest"
+ },
+ "response": {
+ "$ref": "CustomEventsBatchInsertResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ }
+ }
+ },
+ "dimensionValues": {
+ "methods": {
+ "query": {
+ "description": "Retrieves list of report dimension values for a list of filters.",
+ "flatPath": "userprofiles/{profileId}/dimensionvalues/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.dimensionValues.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "100",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "CreativeAssetId": {
- "description": "Creative Asset ID.",
- "id": "CreativeAssetId",
- "properties": {
- "name": {
- "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
- "type": "string"
- },
- "type": {
- "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
- "enum": [
- "IMAGE",
- "FLASH",
- "VIDEO",
- "HTML",
- "HTML_IMAGE",
- "AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAssetMetadata": {
- "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
- "id": "CreativeAssetMetadata",
- "properties": {
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "ID of the creative asset. This is a required field."
- },
- "clickTags": {
- "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
- "items": {
- "$ref": "ClickTag"
- },
- "type": "array"
- },
- "counterCustomEvents": {
- "description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "detectedFeatures": {
- "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
- "items": {
- "enum": [
- "CSS_FONT_FACE",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_FLEX_BOX",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_ANIMATIONS",
- "CSS_COLUMNS",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_REFLECTIONS",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "APPLICATION_CACHE",
- "CANVAS",
- "CANVAS_TEXT",
- "DRAG_AND_DROP",
- "HASH_CHANGE",
- "HISTORY",
- "AUDIO",
- "VIDEO",
- "INDEXED_DB",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_WEEK",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_COLOR",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS",
- "GEO_LOCATION",
- "INLINE_SVG",
- "SMIL",
- "SVG_HREF",
- "SVG_CLIP_PATHS",
- "TOUCH",
- "WEBGL",
- "SVG_FILTERS",
- "SVG_FE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "exitCustomEvents": {
- "description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "id": {
- "description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
- "type": "string"
- },
- "richMedia": {
- "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.",
- "type": "boolean"
- },
- "timerCustomEvents": {
- "description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
- "items": {
- "$ref": "CreativeCustomEvent"
- },
- "type": "array"
- },
- "warnedValidationRules": {
- "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
- "items": {
- "enum": [
- "CLICK_TAG_NON_TOP_LEVEL",
- "CLICK_TAG_MISSING",
- "CLICK_TAG_MORE_THAN_ONE",
- "CLICK_TAG_INVALID",
- "ORPHANED_ASSET",
- "PRIMARY_HTML_MISSING",
- "EXTERNAL_FILE_REFERENCED",
- "MRAID_REFERENCED",
- "ADMOB_REFERENCED",
- "FILE_TYPE_INVALID",
- "ZIP_INVALID",
- "LINKED_FILE_NOT_FOUND",
- "MAX_FLASH_VERSION_11",
- "NOT_SSL_COMPLIANT",
- "FILE_DETAIL_EMPTY",
- "ASSET_INVALID",
- "GWD_PROPERTIES_INVALID",
- "ENABLER_UNSUPPORTED_METHOD_DCM",
- "ASSET_FORMAT_UNSUPPORTED_DCM",
- "COMPONENT_UNSUPPORTED_DCM",
- "HTML5_FEATURE_UNSUPPORTED",
- "CLICK_TAG_IN_GWD",
- "CLICK_TAG_HARD_CODED",
- "SVG_INVALID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dimensionvalues/query",
+ "request": {
+ "$ref": "DimensionValueRequest"
+ },
+ "response": {
+ "$ref": "DimensionValueList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "directorySites": {
+ "methods": {
+ "get": {
+ "description": "Gets one directory site by ID.",
+ "flatPath": "userprofiles/{profileId}/directorySites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Directory site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeAssetSelection": {
- "description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
- "id": "CreativeAssetSelection",
- "properties": {
- "defaultAssetId": {
- "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "rules": {
- "description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites/{id}",
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new directory site.",
+ "flatPath": "userprofiles/{profileId}/directorySites",
+ "httpMethod": "POST",
+ "id": "dfareporting.directorySites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites",
+ "request": {
+ "$ref": "DirectorySite"
+ },
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/directorySites",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeAssignment": {
- "description": "Creative Assignment.",
- "id": "CreativeAssignment",
- "properties": {
- "active": {
- "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.",
- "type": "boolean"
- },
- "applyEventTags": {
- "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
- "type": "boolean"
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of the creative assignment."
- },
- "companionCreativeOverrides": {
- "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
- "items": {
- "$ref": "CompanionClickThroughOverride"
- },
- "type": "array"
- },
- "creativeGroupAssignments": {
- "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- },
- "type": "array"
- },
- "creativeId": {
- "description": "ID of the creative to be assigned. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "creativeIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
- },
- "endTime": {
- "format": "date-time",
- "type": "string"
- },
- "richMediaExitOverrides": {
- "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
- "items": {
- "$ref": "RichMediaExitOverride"
- },
- "type": "array"
- },
- "sequence": {
- "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "sslCompliant": {
- "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- },
- "startTime": {
- "format": "date-time",
- "type": "string"
- },
- "weight": {
- "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- }
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeClickThroughUrl": {
- "description": "Click-through URL",
- "id": "CreativeClickThroughUrl",
- "properties": {
- "computedClickThroughUrl": {
- "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
- "type": "string"
- },
- "customClickThroughUrl": {
- "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
- "type": "string"
- },
- "landingPageId": {
- "description": "ID of the landing page for the click-through URL.",
- "format": "int64",
- "type": "string"
- }
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeCustomEvent": {
- "description": "Creative Custom Event.",
- "id": "CreativeCustomEvent",
- "properties": {
- "advertiserCustomEventId": {
- "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserCustomEventName": {
- "description": "User-entered name for the event.",
- "type": "string"
- },
- "advertiserCustomEventType": {
- "description": "Type of the event. This is a read-only field.",
- "enum": [
- "ADVERTISER_EVENT_TIMER",
- "ADVERTISER_EVENT_EXIT",
- "ADVERTISER_EVENT_COUNTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "artworkLabel": {
- "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
- "type": "string"
- },
- "artworkType": {
- "description": "Artwork type used by the creative.This is a read-only field.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED",
- "ARTWORK_TYPE_IMAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "exitClickThroughUrl": {
- "$ref": "CreativeClickThroughUrl",
- "description": "Exit click-through URL for the event. This field is used only for exit events."
- },
- "id": {
- "description": "ID of this event. This is a required field and should not be modified after insertion.",
- "format": "int64",
- "type": "string"
- },
- "popupWindowProperties": {
- "$ref": "PopupWindowProperties",
- "description": "Properties for rich media popup windows. This field is used only for exit events."
- },
- "targetType": {
- "description": "Target type used by the event.",
- "enum": [
- "TARGET_BLANK",
- "TARGET_TOP",
- "TARGET_SELF",
- "TARGET_PARENT",
- "TARGET_POPUP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "videoReportingId": {
- "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
- "type": "string"
- }
+ "active": {
+ "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CreativeField": {
- "description": "Contains properties of a creative field.",
- "id": "CreativeField",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative field. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this creative field. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "dfpNetworkCode": {
+ "description": "Select only directory sites with this Ad Manager network code.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeFieldAssignment": {
- "description": "Creative Field Assignment.",
- "id": "CreativeFieldAssignment",
- "properties": {
- "creativeFieldId": {
- "description": "ID of the creative field.",
- "format": "int64",
- "type": "string"
- },
- "creativeFieldValueId": {
- "description": "ID of the creative field value.",
- "format": "int64",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only directory sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeFieldValue": {
- "description": "Contains properties of a creative field value.",
- "id": "CreativeFieldValue",
- "properties": {
- "id": {
- "description": "ID of this creative field value. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
- "type": "string"
- },
- "value": {
- "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "CreativeFieldValuesListResponse": {
- "description": "Creative Field Value List Response",
- "id": "CreativeFieldValuesListResponse",
- "properties": {
- "creativeFieldValues": {
- "description": "Creative field value collection.",
- "items": {
- "$ref": "CreativeFieldValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeFieldsListResponse": {
- "description": "Creative Field List Response",
- "id": "CreativeFieldsListResponse",
- "properties": {
- "creativeFields": {
- "description": "Creative field collection.",
- "items": {
- "$ref": "CreativeField"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeGroup": {
- "description": "Contains properties of a creative group.",
- "id": "CreativeGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this creative group. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "groupNumber": {
- "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "ID of this creative group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeGroupAssignment": {
- "description": "Creative Group Assignment.",
- "id": "CreativeGroupAssignment",
- "properties": {
- "creativeGroupId": {
- "description": "ID of the creative group to be assigned.",
- "format": "int64",
- "type": "string"
- },
- "creativeGroupNumber": {
- "description": "Creative group number of the creative group assignment.",
- "enum": [
- "CREATIVE_GROUP_ONE",
- "CREATIVE_GROUP_TWO"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CreativeGroupsListResponse": {
- "description": "Creative Group List Response",
- "id": "CreativeGroupsListResponse",
- "properties": {
- "creativeGroups": {
- "description": "Creative group collection.",
- "items": {
- "$ref": "CreativeGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/directorySites",
+ "response": {
+ "$ref": "DirectorySitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "dynamicTargetingKeys": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing dynamic targeting key.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.dynamicTargetingKeys.delete",
+ "parameterOrder": [
+ "profileId",
+ "objectId",
+ "name",
+ "objectType"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeOptimizationConfiguration": {
- "description": "Creative optimization settings.",
- "id": "CreativeOptimizationConfiguration",
- "properties": {
- "id": {
- "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.",
- "type": "string"
- },
- "optimizationActivitys": {
- "description": "List of optimization activities associated with this configuration.",
- "items": {
- "$ref": "OptimizationActivity"
- },
- "type": "array"
- },
- "optimizationModel": {
- "description": "Optimization model for this configuration.",
- "enum": [
- "CLICK",
- "POST_CLICK",
- "POST_IMPRESSION",
- "POST_CLICK_AND_IMPRESSION",
- "VIDEO_COMPLETION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativeRotation": {
- "description": "Creative Rotation.",
- "id": "CreativeRotation",
- "properties": {
- "creativeAssignments": {
- "description": "Creative assignments in this creative rotation.",
- "items": {
- "$ref": "CreativeAssignment"
- },
- "type": "array"
- },
- "creativeOptimizationConfigurationId": {
- "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
- "enum": [
- "CREATIVE_ROTATION_TYPE_SEQUENTIAL",
- "CREATIVE_ROTATION_TYPE_RANDOM"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "weightCalculationStrategy": {
- "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
- "enum": [
- "WEIGHT_STRATEGY_EQUAL",
- "WEIGHT_STRATEGY_CUSTOM",
- "WEIGHT_STRATEGY_HIGHEST_CTR",
- "WEIGHT_STRATEGY_OPTIMIZED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CreativesListResponse": {
- "description": "Creative List Response",
- "id": "CreativesListResponse",
- "properties": {
- "creatives": {
- "description": "Creative collection.",
- "items": {
- "$ref": "Creative"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "POST",
+ "id": "dfareporting.dynamicTargetingKeys.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "request": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "response": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of dynamic targeting keys.",
+ "flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "GET",
+ "id": "dfareporting.dynamicTargetingKeys.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CrossDimensionReachReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "id": "CrossDimensionReachReportCompatibleFields",
- "properties": {
- "breakdown": {
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "overlapMetrics": {
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "names": {
+ "description": "Select only dynamic targeting keys exactly matching these names.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomEvent": {
- "description": "Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.",
- "id": "CustomEvent",
- "properties": {
- "annotateClickEvent": {
- "$ref": "CustomEventClickAnnotation",
- "description": "Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field."
- },
- "annotateImpressionEvent": {
- "$ref": "CustomEventImpressionAnnotation",
- "description": "Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field."
- },
- "customVariables": {
- "description": "Custom variables associated with the event.",
- "items": {
- "$ref": "CustomVariable"
- },
- "type": "array"
- },
- "eventType": {
- "description": "The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated.",
- "enum": [
- "UNKNOWN",
- "INSERT",
- "ANNOTATE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of the advertiser the event is linked to. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "insertEvent": {
- "$ref": "CustomEventInsert",
- "description": "Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEvent\".",
- "type": "string"
- },
- "ordinal": {
- "description": "The ordinal of this custom event. This is a required field.",
- "type": "string"
- },
- "timestampMicros": {
- "description": "The timestamp of this custom event, in Unix epoch micros. This is a required field.",
- "format": "int64",
- "type": "string"
- }
+ "objectId": {
+ "description": "Select only dynamic targeting keys with this object ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventClickAnnotation": {
- "description": "Annotate a click event.",
- "id": "CustomEventClickAnnotation",
- "properties": {
- "gclid": {
- "description": "The Google click ID. Use this field to annotate the click associated with the gclid.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventClickAnnotation\".",
- "type": "string"
- }
+ "objectType": {
+ "description": "Select only dynamic targeting keys with this object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventError": {
- "description": "The error code and description for a custom event that failed to insert.",
- "id": "CustomEventError",
- "properties": {
- "code": {
- "description": "The error code.",
- "enum": [
- "UNKNOWN",
- "INVALID_ARGUMENT",
- "INTERNAL",
- "PERMISSION_DENIED",
- "NOT_FOUND"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventError\".",
- "type": "string"
- },
- "message": {
- "description": "A description of the error.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "response": {
+ "$ref": "DynamicTargetingKeysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "eventTags": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.eventTags.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventImpressionAnnotation": {
- "description": "Annotate an impression.",
- "id": "CustomEventImpressionAnnotation",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventImpressionAnnotation\".",
- "type": "string"
- },
- "pathImpressionId": {
- "description": "The path impression ID. Use this field to annotate the impression associated with the pathImpressionId.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one event tag by ID.",
+ "flatPath": "userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventInsert": {
- "description": "Custom event to be inserted.",
- "id": "CustomEventInsert",
- "properties": {
- "cmDimensions": {
- "$ref": "CampaignManagerIds",
- "description": "Campaign Manager dimensions associated with the event."
- },
- "dv3Dimensions": {
- "$ref": "DV3Ids",
- "description": "DV360 dimensions associated with the event."
- },
- "insertEventType": {
- "description": "The type of event to insert.",
- "enum": [
- "UNKNOWN",
- "IMPRESSION",
- "CLICK"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventInsert\".",
- "type": "string"
- },
- "matchId": {
- "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required.",
- "type": "string"
- },
- "mobileDeviceId": {
- "description": "The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags/{id}",
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "POST",
+ "id": "dfareporting.eventTags.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of event tags, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "adId": {
+ "description": "Select only event tags that belong to this ad.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventStatus": {
- "description": "The original custom event that was inserted and whether there were any errors.",
- "id": "CustomEventStatus",
- "properties": {
- "customEvent": {
- "$ref": "CustomEvent",
- "description": "The original custom event that was inserted."
- },
- "errors": {
- "description": "A list of errors related to this custom event.",
- "items": {
- "$ref": "CustomEventError"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventStatus\".",
- "type": "string"
- }
+ "advertiserId": {
+ "description": "Select only event tags that belong to this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventsBatchInsertRequest": {
- "description": "Insert Custom Events Request.",
- "id": "CustomEventsBatchInsertRequest",
- "properties": {
- "customEvents": {
- "description": "The set of custom events to insert.",
- "items": {
- "$ref": "CustomEvent"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertRequest\".",
- "type": "string"
- }
+ "campaignId": {
+ "description": "Select only event tags that belong to this campaign.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "CustomEventsBatchInsertResponse": {
- "description": "Insert Custom Events Response.",
- "id": "CustomEventsBatchInsertResponse",
- "properties": {
- "hasFailures": {
- "description": "Indicates that some or all custom events failed to insert.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertResponse\".",
- "type": "string"
- },
- "status": {
- "description": "The insert status of each custom event. Statuses are returned in the same order that conversions are inserted.",
- "items": {
- "$ref": "CustomEventStatus"
- },
- "type": "array"
- }
+ "definitionsOnly": {
+ "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CustomFloodlightVariable": {
- "description": "A custom floodlight variable.",
- "id": "CustomFloodlightVariable",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
- "type": "string"
- },
- "type": {
- "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.",
- "type": "string"
- }
+ "enabled": {
+ "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "CustomRichMediaEvents": {
- "description": "Represents a Custom Rich Media Events group.",
- "id": "CustomRichMediaEvents",
- "properties": {
- "filteredEventIds": {
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "type": "string"
- }
+ "eventTagTypes": {
+ "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomVariable": {
- "description": "Custom variable.",
- "id": "CustomVariable",
- "properties": {
- "index": {
- "description": "The index of the custom variable.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customVariable\".",
- "type": "string"
- },
- "value": {
- "description": "The value of the custom variable. The length of string must not exceed 50 characters.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only event tags with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomViewabilityMetric": {
- "description": "Custom Viewability Metric",
- "id": "CustomViewabilityMetric",
- "properties": {
- "configuration": {
- "$ref": "CustomViewabilityMetricConfiguration",
- "description": "Configuration of the custom viewability metric."
- },
- "id": {
- "description": "ID of the custom viewability metric.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of the custom viewability metric.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "CustomViewabilityMetricConfiguration": {
- "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
- "id": "CustomViewabilityMetricConfiguration",
- "properties": {
- "audible": {
- "description": "Whether the video must be audible to count an impression.",
- "type": "boolean"
- },
- "timeMillis": {
- "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.",
- "format": "int32",
- "type": "integer"
- },
- "timePercent": {
- "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
- "format": "int32",
- "type": "integer"
- },
- "viewabilityPercent": {
- "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.",
- "format": "int32",
- "type": "integer"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DV3Ids": {
- "description": "DV360 IDs related to the custom event.",
- "id": "DV3Ids",
- "properties": {
- "dvCampaignId": {
- "description": "Campaign ID for DV360.",
- "format": "int64",
- "type": "string"
- },
- "dvCreativeId": {
- "description": "Creative ID for DV360.",
- "format": "int64",
- "type": "string"
- },
- "dvInsertionOrderId": {
- "description": "Insertion Order ID for DV360.",
- "format": "int64",
- "type": "string"
- },
- "dvLineItemId": {
- "description": "Line Item ID for DV360.",
- "format": "int64",
- "type": "string"
- },
- "dvSiteId": {
- "description": "Site ID for DV360.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dV3Ids\".",
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DateRange": {
- "description": "Represents a date range.",
- "id": "DateRange",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "type": "string"
- },
- "relativeDateRange": {
- "description": "The date range relative to the date of when the report is run.",
- "enum": [
- "TODAY",
- "YESTERDAY",
- "WEEK_TO_DATE",
- "MONTH_TO_DATE",
- "QUARTER_TO_DATE",
- "YEAR_TO_DATE",
- "PREVIOUS_WEEK",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_YEAR",
- "LAST_7_DAYS",
- "LAST_30_DAYS",
- "LAST_90_DAYS",
- "LAST_365_DAYS",
- "LAST_24_MONTHS",
- "LAST_14_DAYS",
- "LAST_60_DAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "response": {
+ "$ref": "EventTagsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing event tag. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.eventTags.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "EventTag ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DayPartTargeting": {
- "description": "Day Part Targeting.",
- "id": "DayPartTargeting",
- "properties": {
- "daysOfWeek": {
- "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ",
- "items": {
- "enum": [
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "hoursOfDay": {
- "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "userLocalTime": {
- "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing event tag.",
+ "flatPath": "userprofiles/{profileId}/eventTags",
+ "httpMethod": "PUT",
+ "id": "dfareporting.eventTags.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.get",
+ "parameterOrder": [
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DeepLink": {
- "description": "Contains information about a landing page deep link.",
- "id": "DeepLink",
- "properties": {
- "appUrl": {
- "description": "The URL of the mobile app being linked to.",
- "type": "string"
- },
- "fallbackUrl": {
- "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".",
- "type": "string"
- },
- "mobileApp": {
- "$ref": "MobileApp",
- "description": "The mobile app targeted by this deep link."
- },
- "remarketingListIds": {
- "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
+ },
+ "list": {
+ "description": "Lists files for a user profile.",
+ "flatPath": "userprofiles/{profileId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "DefaultClickThroughEventTagProperties": {
- "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
- "id": "DefaultClickThroughEventTagProperties",
- "properties": {
- "defaultClickThroughEventTagId": {
- "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
- "format": "int64",
- "type": "string"
- },
- "overrideInheritedEventTag": {
- "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.",
- "type": "boolean"
- }
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DeliverySchedule": {
- "description": "Delivery Schedule.",
- "id": "DeliverySchedule",
- "properties": {
- "frequencyCap": {
- "$ref": "FrequencyCap",
- "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
- },
- "hardCutoff": {
- "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.",
- "type": "boolean"
- },
- "impressionRatio": {
- "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "priority": {
- "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
- "enum": [
- "AD_PRIORITY_01",
- "AD_PRIORITY_02",
- "AD_PRIORITY_03",
- "AD_PRIORITY_04",
- "AD_PRIORITY_05",
- "AD_PRIORITY_06",
- "AD_PRIORITY_07",
- "AD_PRIORITY_08",
- "AD_PRIORITY_09",
- "AD_PRIORITY_10",
- "AD_PRIORITY_11",
- "AD_PRIORITY_12",
- "AD_PRIORITY_13",
- "AD_PRIORITY_14",
- "AD_PRIORITY_15",
- "AD_PRIORITY_16"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DfpSettings": {
- "description": "Google Ad Manager Settings",
- "id": "DfpSettings",
- "properties": {
- "dfpNetworkCode": {
- "description": "Ad Manager network code for this directory site.",
- "type": "string"
- },
- "dfpNetworkName": {
- "description": "Ad Manager network name for this directory site.",
- "type": "string"
- },
- "programmaticPlacementAccepted": {
- "description": "Whether this directory site accepts programmatic placements.",
- "type": "boolean"
- },
- "pubPaidPlacementAccepted": {
- "description": "Whether this directory site accepts publisher-paid tags.",
- "type": "boolean"
- },
- "publisherPortalOnly": {
- "description": "Whether this directory site is available only via Publisher Portal.",
- "type": "boolean"
- }
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE",
+ "SHARED_WITH_ME"
+ ],
+ "enumDescriptions": [
+ "All files in account.",
+ "My files.",
+ "Files shared with me."
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Dimension": {
- "description": "Represents a dimension.",
- "id": "Dimension",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "type": "string"
- },
- "name": {
- "description": "The dimension name, e.g. dfa:advertiser",
- "type": "string"
- }
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "Sort by file ID.",
+ "Sort by 'lastmodifiedAt' field."
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DimensionFilter": {
- "description": "Represents a dimension filter.",
- "id": "DimensionFilter",
- "properties": {
- "dimensionName": {
- "description": "The name of the dimension to filter.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "type": "string"
- },
- "value": {
- "description": "The value of the dimension to filter.",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "floodlightActivities": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.floodlightActivities.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DimensionValue": {
- "description": "Represents a DimensionValue resource.",
- "id": "DimensionValue",
- "properties": {
- "dimensionName": {
- "description": "The name of the dimension.",
- "type": "string"
- },
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "id": {
- "description": "The ID associated with the value if available.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "type": "string"
- },
- "matchType": {
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "EXACT",
- "BEGINS_WITH",
- "CONTAINS",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "The value of the dimension.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "generatetag": {
+ "description": "Generates a tag for a floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/generatetag",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.generatetag",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID for which we want to generate a tag.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DimensionValueList": {
- "description": "Represents the list of DimensionValue resources.",
- "id": "DimensionValueList",
- "properties": {
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "items": {
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
+ "response": {
+ "$ref": "FloodlightActivitiesGenerateTagResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one floodlight activity by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "DimensionValueRequest": {
- "description": "Represents a DimensionValuesRequest.",
- "id": "DimensionValueRequest",
- "properties": {
- "dimensionName": {
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- },
- "description": "The name of the dimension for which values should be requested.",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "filters": {
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities/{id}",
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySite": {
- "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
- "id": "DirectorySite",
- "properties": {
- "id": {
- "description": "ID of this directory site. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
- },
- "inpageTagFormats": {
- "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ",
- "items": {
- "enum": [
- "STANDARD",
- "IFRAME_JAVASCRIPT_INPAGE",
- "INTERNAL_REDIRECT_INPAGE",
- "JAVASCRIPT_INPAGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "interstitialTagFormats": {
- "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ",
- "items": {
- "enum": [
- "IFRAME_JAVASCRIPT_INTERSTITIAL",
- "INTERNAL_REDIRECT_INTERSTITIAL",
- "JAVASCRIPT_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this directory site.",
- "type": "string"
- },
- "settings": {
- "$ref": "DirectorySiteSettings",
- "description": "Directory site settings."
- },
- "url": {
- "description": "URL of this directory site.",
- "type": "string"
- }
+ "floodlightActivityGroupIds": {
+ "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySiteSettings": {
- "description": "Directory Site Settings",
- "id": "DirectorySiteSettings",
- "properties": {
- "activeViewOptOut": {
- "description": "Whether this directory site has disabled active view creatives.",
- "type": "boolean"
- },
- "dfpSettings": {
- "$ref": "DfpSettings",
- "description": "Directory site Ad Manager settings."
- },
- "instreamVideoPlacementAccepted": {
- "description": "Whether this site accepts in-stream video ads.",
- "type": "boolean"
- },
- "interstitialPlacementAccepted": {
- "description": "Whether this site accepts interstitial ads.",
- "type": "boolean"
- }
+ "floodlightActivityGroupName": {
+ "description": "Select only floodlight activities with the specified floodlight activity group name.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DirectorySitesListResponse": {
- "description": "Directory Site List Response",
- "id": "DirectorySitesListResponse",
- "properties": {
- "directorySites": {
- "description": "Directory site collection.",
- "items": {
- "$ref": "DirectorySite"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DisjunctiveMatchStatement": {
- "description": "Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.",
- "id": "DisjunctiveMatchStatement",
- "properties": {
- "eventFilters": {
- "description": "The event filters contained within this disjunctive match statement.",
- "items": {
- "$ref": "EventFilter"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DynamicTargetingKey": {
- "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
- "id": "DynamicTargetingKey",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
- "type": "string"
- },
- "objectId": {
- "description": "ID of the object of this dynamic targeting key. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "objectType": {
- "description": "Type of the object of this dynamic targeting key. This is a required field.",
- "enum": [
- "OBJECT_ADVERTISER",
- "OBJECT_AD",
- "OBJECT_CREATIVE",
- "OBJECT_PLACEMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "floodlightActivityGroupTagString": {
+ "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "DynamicTargetingKeysListResponse": {
- "description": "Dynamic Targeting Key List Response",
- "id": "DynamicTargetingKeysListResponse",
- "properties": {
- "dynamicTargetingKeys": {
- "description": "Dynamic targeting key collection.",
- "items": {
- "$ref": "DynamicTargetingKey"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
- "type": "string"
- }
+ "floodlightActivityGroupType": {
+ "description": "Select only floodlight activities with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "EncryptionInfo": {
- "description": "A description of how user IDs are encrypted.",
- "id": "EncryptionInfo",
- "properties": {
- "encryptionEntityId": {
- "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
- "format": "int64",
- "type": "string"
- },
- "encryptionEntityType": {
- "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
- "enum": [
- "ENCRYPTION_ENTITY_TYPE_UNKNOWN",
- "DCM_ACCOUNT",
- "DCM_ADVERTISER",
- "DBM_PARTNER",
- "DBM_ADVERTISER",
- "ADWORDS_CUSTOMER",
- "DFP_NETWORK_CODE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "encryptionSource": {
- "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
- "enum": [
- "ENCRYPTION_SCOPE_UNKNOWN",
- "AD_SERVING",
- "DATA_TRANSFER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
- "type": "string"
- }
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "EventFilter": {
- "description": "Represents a DfaReporting event filter.",
- "id": "EventFilter",
- "properties": {
- "dimensionFilter": {
- "$ref": "PathReportDimensionValue",
- "description": "The dimension filter contained within this EventFilter."
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#eventFilter.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "EventTag": {
- "description": "Contains properties of an event tag.",
- "id": "EventTag",
- "properties": {
- "accountId": {
- "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "campaignId": {
- "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "enabledByDefault": {
- "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.",
- "type": "boolean"
- },
- "excludeFromAdxRequests": {
- "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this event tag. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this event tag. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "siteFilterType": {
- "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
- "enum": [
- "WHITELIST",
- "BLACKLIST"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "siteIds": {
- "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "sslCompliant": {
- "description": "Whether this tag is SSL-compliant or not. This is a read-only field.",
- "type": "boolean"
- },
- "status": {
- "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
- "enum": [
- "ENABLED",
- "DISABLED"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
- "enum": [
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG",
- "CLICK_THROUGH_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "url": {
- "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.",
- "type": "string"
- },
- "urlEscapeLevels": {
- "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
- "format": "int32",
- "type": "integer"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "EventTagOverride": {
- "description": "Event tag override information.",
- "id": "EventTagOverride",
- "properties": {
- "enabled": {
- "description": "Whether this override is enabled.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this event tag override. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "EventTagsListResponse": {
- "description": "Event Tag List Response",
- "id": "EventTagsListResponse",
- "properties": {
- "eventTags": {
- "description": "Event tag collection.",
- "items": {
- "$ref": "EventTag"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "File": {
- "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "id": "File",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "fileName": {
- "description": "The filename of the file.",
- "type": "string"
- },
- "format": {
- "description": "The output format of the report. Only available once the file is available.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "The unique ID of this report file.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
- "type": "string"
- },
- "lastModifiedTime": {
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64",
- "type": "string"
- },
- "reportId": {
- "description": "The ID of the report this file was generated from.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "description": "The status of the report file.",
- "enum": [
- "PROCESSING",
- "REPORT_AVAILABLE",
- "FAILED",
- "CANCELLED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "urls": {
- "description": "The URLs where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "description": "The URL for downloading the report data through the API.",
- "type": "string"
- },
- "browserUrl": {
- "description": "The URL for downloading the report data through a browser.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FileList": {
- "description": "List of files for a report.",
- "id": "FileList",
- "properties": {
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "items": {
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Flight": {
- "description": "Flight",
- "id": "Flight",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "rateOrCost": {
- "description": "Rate or cost of this flight.",
- "format": "int64",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "units": {
- "description": "Units of this flight.",
- "format": "int64",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivitiesGenerateTagResponse": {
- "description": "Floodlight Activity GenerateTag Response",
- "id": "FloodlightActivitiesGenerateTagResponse",
- "properties": {
- "floodlightActivityTag": {
- "description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
- "type": "string"
- },
- "globalSiteTagGlobalSnippet": {
- "description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
- "type": "string"
- }
+ "tagString": {
+ "description": "Select only floodlight activities with the specified tag string.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "response": {
+ "$ref": "FloodlightActivitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivities.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivity ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivitiesListResponse": {
- "description": "Floodlight Activity List Response",
- "id": "FloodlightActivitiesListResponse",
- "properties": {
- "floodlightActivities": {
- "description": "Floodlight activity collection.",
- "items": {
- "$ref": "FloodlightActivity"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivities.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightActivityGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight activity group by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity Group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivity": {
- "description": "Contains properties of a Floodlight activity.",
- "id": "FloodlightActivity",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "attributionEnabled": {
- "description": "Whether the activity is enabled for attribution.",
- "type": "boolean"
- },
- "cacheBustingType": {
- "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
- "enum": [
- "JAVASCRIPT",
- "ACTIVE_SERVER_PAGE",
- "JSP",
- "PHP",
- "COLD_FUSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "countingMethod": {
- "description": "Counting method for conversions for this floodlight activity. This is a required field.",
- "enum": [
- "STANDARD_COUNTING",
- "UNIQUE_COUNTING",
- "SESSION_COUNTING",
- "TRANSACTIONS_COUNTING",
- "ITEMS_SOLD_COUNTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "defaultTags": {
- "description": "Dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityDynamicTag"
- },
- "type": "array"
- },
- "expectedUrl": {
- "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
- "type": "string"
- },
- "floodlightActivityGroupId": {
- "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityGroupName": {
- "description": "Name of the associated floodlight activity group. This is a read-only field.",
- "type": "string"
- },
- "floodlightActivityGroupTagString": {
- "description": "Tag string of the associated floodlight activity group. This is a read-only field.",
- "type": "string"
- },
- "floodlightActivityGroupType": {
- "description": "Type of the associated floodlight activity group. This is a read-only field.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "floodlightTagType": {
- "description": "The type of Floodlight tag this activity will generate. This is a required field.",
- "enum": [
- "IFRAME",
- "IMAGE",
- "GLOBAL_SITE_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.",
- "type": "string"
- },
- "notes": {
- "description": "General notes or implementation instructions for the tag.",
- "type": "string"
- },
- "publisherTags": {
- "description": "Publisher dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityPublisherDynamicTag"
- },
- "type": "array"
- },
- "secure": {
- "description": "Whether this tag should use SSL.",
- "type": "boolean"
- },
- "sslCompliant": {
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
- "type": "boolean"
- },
- "sslRequired": {
- "description": "Whether this floodlight activity must be SSL-compliant.",
- "type": "boolean"
- },
- "status": {
- "description": "The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.",
- "enum": [
- "ACTIVE",
- "ARCHIVED_AND_DISABLED",
- "ARCHIVED",
- "DISABLED_POLICY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagFormat": {
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
- "enum": [
- "HTML",
- "XHTML"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "tagString": {
- "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
- "type": "string"
- },
- "userDefinedVariableTypes": {
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
- "items": {
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity group.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivityGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityDynamicTag": {
- "description": "Dynamic Tag",
- "id": "FloodlightActivityDynamicTag",
- "properties": {
- "id": {
- "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of this tag.",
- "type": "string"
- },
- "tag": {
- "description": "Tag code.",
- "type": "string"
- }
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityGroup": {
- "description": "Contains properties of a Floodlight activity group.",
- "id": "FloodlightActivityGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "floodlightConfigurationId": {
- "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagString": {
- "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
- "type": "string"
- },
- "type": {
- "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "ids": {
+ "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightActivityGroupsListResponse": {
- "description": "Floodlight Activity Group List Response",
- "id": "FloodlightActivityGroupsListResponse",
- "properties": {
- "floodlightActivityGroups": {
- "description": "Floodlight activity group collection.",
- "items": {
- "$ref": "FloodlightActivityGroup"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "FloodlightActivityPublisherDynamicTag": {
- "description": "Publisher Dynamic Tag",
- "id": "FloodlightActivityPublisherDynamicTag",
- "properties": {
- "clickThrough": {
- "description": "Whether this tag is applicable only for click-throughs.",
- "type": "boolean"
- },
- "directorySiteId": {
- "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
- "format": "int64",
- "type": "string"
- },
- "dynamicTag": {
- "$ref": "FloodlightActivityDynamicTag",
- "description": "Dynamic floodlight tag."
- },
- "siteId": {
- "description": "Site ID of this dynamic tag.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "viewThrough": {
- "description": "Whether this tag is applicable only for view-throughs.",
- "type": "boolean"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightConfiguration": {
- "description": "Contains properties of a Floodlight configuration.",
- "id": "FloodlightConfiguration",
- "properties": {
- "accountId": {
- "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "analyticsDataSharingEnabled": {
- "description": "Whether advertiser data is shared with Google Analytics.",
- "type": "boolean"
- },
- "customViewabilityMetric": {
- "$ref": "CustomViewabilityMetric",
- "description": "Custom Viewability metric for the floodlight configuration."
- },
- "exposureToConversionEnabled": {
- "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
- "type": "boolean"
- },
- "firstDayOfWeek": {
- "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
- "enum": [
- "MONDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
- },
- "inAppAttributionTrackingEnabled": {
- "description": "Whether in-app attribution tracking is enabled.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
- "type": "string"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this floodlight configuration."
- },
- "naturalSearchConversionAttributionOption": {
- "description": "Types of attribution options for natural search conversions.",
- "enum": [
- "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "omnitureSettings": {
- "$ref": "OmnitureSettings",
- "description": "Settings for Campaign Manager Omniture integration."
- },
- "subaccountId": {
- "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagSettings": {
- "$ref": "TagSettings",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "thirdPartyAuthenticationTokens": {
- "description": "List of third-party authentication tokens enabled for this configuration.",
- "items": {
- "$ref": "ThirdPartyAuthenticationToken"
- },
- "type": "array"
- },
- "userDefinedVariableConfigurations": {
- "description": "List of user defined variables enabled for this configuration.",
- "items": {
- "$ref": "UserDefinedVariableConfiguration"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightConfigurationsListResponse": {
- "description": "Floodlight Configuration List Response",
- "id": "FloodlightConfigurationsListResponse",
- "properties": {
- "floodlightConfigurations": {
- "description": "Floodlight configuration collection.",
- "items": {
- "$ref": "FloodlightConfiguration"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FloodlightReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "id": "FloodlightReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FrequencyCap": {
- "description": "Frequency Cap.",
- "id": "FrequencyCap",
- "properties": {
- "duration": {
- "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "impressions": {
- "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
- "format": "int64",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "FsCommand": {
- "description": "FsCommand.",
- "id": "FsCommand",
- "properties": {
- "left": {
- "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32",
- "type": "integer"
- },
- "positionOption": {
- "description": "Position in the browser where the window will open.",
- "enum": [
- "CENTERED",
- "DISTANCE_FROM_TOP_LEFT_CORNER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "top": {
- "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32",
- "type": "integer"
- },
- "windowHeight": {
- "description": "Height of the window.",
- "format": "int32",
- "type": "integer"
- },
- "windowWidth": {
- "description": "Width of the window.",
- "format": "int32",
- "type": "integer"
- }
+ "type": {
+ "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "response": {
+ "$ref": "FloodlightActivityGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivityGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivityGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "GeoTargeting": {
- "description": "Geographical Targeting.",
- "id": "GeoTargeting",
- "properties": {
- "cities": {
- "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
- "items": {
- "$ref": "City"
- },
- "type": "array"
- },
- "countries": {
- "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
- "items": {
- "$ref": "Country"
- },
- "type": "array"
- },
- "excludeCountries": {
- "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.",
- "type": "boolean"
- },
- "metros": {
- "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
- "items": {
- "$ref": "Metro"
- },
- "type": "array"
- },
- "postalCodes": {
- "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
- "items": {
- "$ref": "PostalCode"
- },
- "type": "array"
- },
- "regions": {
- "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity group.",
+ "flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivityGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightConfigurations": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight configuration by ID.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight configuration ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "InventoryItem": {
- "description": "Represents a buy from the Planning inventory store.",
- "id": "InventoryItem",
- "properties": {
- "accountId": {
- "description": "Account ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "adSlots": {
- "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
- "items": {
- "$ref": "AdSlot"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "contentCategoryId": {
- "description": "Content category ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "estimatedClickThroughRate": {
- "description": "Estimated click-through rate of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "estimatedConversionRate": {
- "description": "Estimated conversion rate of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "inPlan": {
- "description": "Whether this inventory item is in plan.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this inventory item."
- },
- "name": {
- "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.",
- "type": "string"
- },
- "negotiationChannelId": {
- "description": "Negotiation channel ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "orderId": {
- "description": "Order ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "placementStrategyId": {
- "description": "Placement strategy ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "pricing": {
- "$ref": "Pricing",
- "description": "Pricing of this inventory item."
- },
- "projectId": {
- "description": "Project ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "rfpId": {
- "description": "RFP ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "siteId": {
- "description": "ID of the site this inventory item is associated with.",
- "format": "int64",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this inventory item.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Type of inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_TYPE_REGULAR",
- "PLANNING_PLACEMENT_TYPE_CREDIT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight configurations, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "InventoryItemsListResponse": {
- "description": "Inventory item List Response",
- "id": "InventoryItemsListResponse",
- "properties": {
- "inventoryItems": {
- "description": "Inventory item collection",
- "items": {
- "$ref": "InventoryItem"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "response": {
+ "$ref": "FloodlightConfigurationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightConfigurations.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightConfiguration ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "KeyValueTargetingExpression": {
- "description": "Key Value Targeting Expression.",
- "id": "KeyValueTargetingExpression",
- "properties": {
- "expression": {
- "description": "Keyword expression being targeted by the ad.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight configuration.",
+ "flatPath": "userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightConfigurations.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "inventoryItems": {
+ "methods": {
+ "get": {
+ "description": "Gets one inventory item by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Inventory item ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "LandingPage": {
- "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
- "id": "LandingPage",
- "properties": {
- "advertiserId": {
- "description": "Advertiser ID of this landing page. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "archived": {
- "description": "Whether this landing page has been archived.",
- "type": "boolean"
- },
- "deepLinks": {
- "description": "Links that will direct the user to a mobile app, if installed.",
- "items": {
- "$ref": "DeepLink"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this landing page. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
- "type": "string"
- },
- "url": {
- "description": "URL of this landing page. This is a required field.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "Language": {
- "description": "Contains information about a language that can be targeted by ads.",
- "id": "Language",
- "properties": {
- "id": {
- "description": "Language ID of this language. This is the ID used for targeting and generating reports.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".",
- "type": "string"
- },
- "languageCode": {
- "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
- "type": "string"
- },
- "name": {
- "description": "Name of this language.",
- "type": "string"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "response": {
+ "$ref": "InventoryItem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only inventory items with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "LanguageTargeting": {
- "description": "Language Targeting.",
- "id": "LanguageTargeting",
- "properties": {
- "languages": {
- "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Language"
- },
- "type": "array"
- }
+ "inPlan": {
+ "description": "Select only inventory items that are in plan.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "LanguagesListResponse": {
- "description": "Language List Response",
- "id": "LanguagesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
- "type": "string"
- },
- "languages": {
- "description": "Language collection.",
- "items": {
- "$ref": "Language"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "LastModifiedInfo": {
- "description": "Modification timestamp.",
- "id": "LastModifiedInfo",
- "properties": {
- "time": {
- "description": "Timestamp of the last change in milliseconds since epoch.",
- "format": "int64",
- "type": "string"
- }
+ "orderId": {
+ "description": "Select only inventory items that belong to specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationClause": {
- "description": "A group clause made up of list population terms representing constraints joined by ORs.",
- "id": "ListPopulationClause",
- "properties": {
- "terms": {
- "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
- "items": {
- "$ref": "ListPopulationTerm"
- },
- "type": "array"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationRule": {
- "description": "Remarketing List Population Rule.",
- "id": "ListPopulationRule",
- "properties": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityName": {
- "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "listPopulationClauses": {
- "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
- "items": {
- "$ref": "ListPopulationClause"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ListPopulationTerm": {
- "description": "Remarketing List Population Rule Term.",
- "id": "ListPopulationTerm",
- "properties": {
- "contains": {
- "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
- "type": "boolean"
- },
- "negation": {
- "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "boolean"
- },
- "operator": {
- "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "enum": [
- "NUM_EQUALS",
- "NUM_LESS_THAN",
- "NUM_LESS_THAN_EQUAL",
- "NUM_GREATER_THAN",
- "NUM_GREATER_THAN_EQUAL",
- "STRING_EQUALS",
- "STRING_CONTAINS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "remarketingListId": {
- "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
- "enum": [
- "CUSTOM_VARIABLE_TERM",
- "LIST_MEMBERSHIP_TERM",
- "REFERRER_TERM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "string"
- },
- "variableFriendlyName": {
- "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
- "type": "string"
- },
- "variableName": {
- "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "type": "string"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ListTargetingExpression": {
- "description": "Remarketing List Targeting Expression.",
- "id": "ListTargetingExpression",
- "properties": {
- "expression": {
- "description": "Expression describing which lists are being targeted by the ad.",
- "type": "string"
- }
+ "siteId": {
+ "description": "Select only inventory items that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "LookbackConfiguration": {
- "description": "Lookback configuration settings.",
- "id": "LookbackConfiguration",
- "properties": {
- "clickDuration": {
- "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "postImpressionActivitiesDuration": {
- "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
- "format": "int32",
- "type": "integer"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Metric": {
- "description": "Represents a metric.",
- "id": "Metric",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "type": "string"
- },
- "name": {
- "description": "The metric name, e.g. dfa:impressions",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "Metro": {
- "description": "Contains information about a metro region that can be targeted by ads.",
- "id": "Metro",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this metro region belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this metro region belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this metro region.",
- "format": "int64",
- "type": "string"
- },
- "dmaId": {
- "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
- "type": "string"
- },
- "metroCode": {
- "description": "Metro code of this metro region. This is equivalent to dma_id.",
- "type": "string"
- },
- "name": {
- "description": "Name of this metro region.",
- "type": "string"
- }
+ "type": {
+ "description": "Select only inventory items with this type.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "response": {
+ "$ref": "InventoryItemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "languages": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of languages.",
+ "flatPath": "userprofiles/{profileId}/languages",
+ "httpMethod": "GET",
+ "id": "dfareporting.languages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/languages",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "metros": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of metros.",
+ "flatPath": "userprofiles/{profileId}/metros",
+ "httpMethod": "GET",
+ "id": "dfareporting.metros.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/metros",
+ "response": {
+ "$ref": "MetrosListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileApps": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile app by ID.",
+ "flatPath": "userprofiles/{profileId}/mobileApps/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile app ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "MetrosListResponse": {
- "description": "Metro List Response",
- "id": "MetrosListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
- "type": "string"
- },
- "metros": {
- "description": "Metro collection.",
- "items": {
- "$ref": "Metro"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileApps/{id}",
+ "response": {
+ "$ref": "MobileApp"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of available mobile apps.",
+ "flatPath": "userprofiles/{profileId}/mobileApps",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "directories": {
+ "description": "Select only apps from these directories.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "MobileApp": {
- "description": "Contains information about a mobile app. Used as a landing page deep link.",
- "id": "MobileApp",
- "properties": {
- "directory": {
- "description": "Mobile app directory.",
- "enum": [
- "UNKNOWN",
- "APPLE_APP_STORE",
- "GOOGLE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this mobile app.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
- "type": "string"
- },
- "publisherName": {
- "description": "Publisher name.",
- "type": "string"
- },
- "title": {
- "description": "Title of this mobile app.",
- "type": "string"
- }
+ "ids": {
+ "description": "Select only apps with these IDs.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "MobileAppsListResponse": {
- "description": "Mobile app List Response",
- "id": "MobileAppsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
- "type": "string"
- },
- "mobileApps": {
- "description": "Mobile apps collection.",
- "items": {
- "$ref": "MobileApp"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "MobileCarrier": {
- "description": "Contains information about a mobile carrier that can be targeted by ads.",
- "id": "MobileCarrier",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this mobile carrier belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this mobile carrier belongs.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this mobile carrier.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this mobile carrier.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "MobileCarriersListResponse": {
- "description": "Mobile Carrier List Response",
- "id": "MobileCarriersListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
- "type": "string"
- },
- "mobileCarriers": {
- "description": "Mobile carrier collection.",
- "items": {
- "$ref": "MobileCarrier"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ObaIcon": {
- "description": "Online Behavioral Advertiser icon.",
- "id": "ObaIcon",
- "properties": {
- "iconClickThroughUrl": {
- "description": "URL to redirect to when an OBA icon is clicked.",
- "type": "string"
- },
- "iconClickTrackingUrl": {
- "description": "URL to track click when an OBA icon is clicked.",
- "type": "string"
- },
- "iconViewTrackingUrl": {
- "description": "URL to track view when an OBA icon is clicked.",
- "type": "string"
- },
- "program": {
- "description": "Identifies the industry initiative that the icon supports. For example, AdChoices.",
- "type": "string"
- },
- "resourceUrl": {
- "description": "OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more",
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "OBA icon size."
- },
- "xPosition": {
- "description": "OBA icon x coordinate position. Accepted values are left or right.",
- "type": "string"
- },
- "yPosition": {
- "description": "OBA icon y coordinate position. Accepted values are top or bottom.",
- "type": "string"
- }
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileApps",
+ "response": {
+ "$ref": "MobileAppsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileCarriers": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile carrier by ID.",
+ "flatPath": "userprofiles/{profileId}/mobileCarriers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile carrier ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "ObjectFilter": {
- "description": "Object Filter.",
- "id": "ObjectFilter",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
- "type": "string"
- },
- "objectIds": {
- "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "status": {
- "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
- "enum": [
- "NONE",
- "ASSIGNED",
- "ALL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileCarriers/{id}",
+ "response": {
+ "$ref": "MobileCarrier"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of mobile carriers.",
+ "flatPath": "userprofiles/{profileId}/mobileCarriers",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/mobileCarriers",
+ "response": {
+ "$ref": "MobileCarriersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystemVersions": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system version by ID.",
+ "flatPath": "userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Operating system version ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OffsetPosition": {
- "description": "Offset Position.",
- "id": "OffsetPosition",
- "properties": {
- "left": {
- "description": "Offset distance from left side of an asset or a window.",
- "format": "int32",
- "type": "integer"
- },
- "top": {
- "description": "Offset distance from top side of an asset or a window.",
- "format": "int32",
- "type": "integer"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "response": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating system versions.",
+ "flatPath": "userprofiles/{profileId}/operatingSystemVersions",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystemVersions",
+ "response": {
+ "$ref": "OperatingSystemVersionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystems": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system by DART ID.",
+ "flatPath": "userprofiles/{profileId}/operatingSystems/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Operating system DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OmnitureSettings": {
- "description": "Omniture Integration Settings.",
- "id": "OmnitureSettings",
- "properties": {
- "omnitureCostDataEnabled": {
- "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
- "type": "boolean"
- },
- "omnitureIntegrationEnabled": {
- "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
- "type": "boolean"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
+ "response": {
+ "$ref": "OperatingSystem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating systems.",
+ "flatPath": "userprofiles/{profileId}/operatingSystems",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/operatingSystems",
+ "response": {
+ "$ref": "OperatingSystemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orderDocuments": {
+ "methods": {
+ "get": {
+ "description": "Gets one order document by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order document ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystem": {
- "description": "Contains information about an operating system that can be targeted by ads.",
- "id": "OperatingSystem",
- "properties": {
- "dartId": {
- "description": "DART ID of this operating system. This is the ID used for targeting.",
- "format": "int64",
- "type": "string"
- },
- "desktop": {
- "description": "Whether this operating system is for desktop.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
- "type": "string"
- },
- "mobile": {
- "description": "Whether this operating system is for mobile.",
- "type": "boolean"
- },
- "name": {
- "description": "Name of this operating system.",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystemVersion": {
- "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
- "id": "OperatingSystemVersion",
- "properties": {
- "id": {
- "description": "ID of this operating system version.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
- "type": "string"
- },
- "majorVersion": {
- "description": "Major version (leftmost number) of this operating system version.",
- "type": "string"
- },
- "minorVersion": {
- "description": "Minor version (number after the first dot) of this operating system version.",
- "type": "string"
- },
- "name": {
- "description": "Name of this operating system version.",
- "type": "string"
- },
- "operatingSystem": {
- "$ref": "OperatingSystem",
- "description": "Operating system of this operating system version."
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "response": {
+ "$ref": "OrderDocument"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "approved": {
+ "description": "Select only order documents that have been approved by at least one user.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "OperatingSystemVersionsListResponse": {
- "description": "Operating System Version List Response",
- "id": "OperatingSystemVersionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
- "type": "string"
- },
- "operatingSystemVersions": {
- "description": "Operating system version collection.",
- "items": {
- "$ref": "OperatingSystemVersion"
- },
- "type": "array"
- }
+ "ids": {
+ "description": "Select only order documents with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "OperatingSystemsListResponse": {
- "description": "Operating System List Response",
- "id": "OperatingSystemsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
- "type": "string"
- },
- "operatingSystems": {
- "description": "Operating system collection.",
- "items": {
- "$ref": "OperatingSystem"
- },
- "type": "array"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "OptimizationActivity": {
- "description": "Creative optimization activity.",
- "id": "OptimizationActivity",
- "properties": {
- "floodlightActivityId": {
- "description": "Floodlight activity ID of this optimization activity. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "floodlightActivityIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
- },
- "weight": {
- "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.",
- "format": "int32",
- "type": "integer"
- }
+ "orderId": {
+ "description": "Select only order documents for specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "Order": {
- "description": "Describes properties of a Planning order.",
- "id": "Order",
- "properties": {
- "accountId": {
- "description": "Account ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "approverUserProfileIds": {
- "description": "IDs for users that have to approve documents created for this order.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "buyerInvoiceId": {
- "description": "Buyer invoice ID associated with this order.",
- "type": "string"
- },
- "buyerOrganizationName": {
- "description": "Name of the buyer organization.",
- "type": "string"
- },
- "comments": {
- "description": "Comments in this order.",
- "type": "string"
- },
- "contacts": {
- "description": "Contacts for this order.",
- "items": {
- "$ref": "OrderContact"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this order. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this order."
- },
- "name": {
- "description": "Name of this order.",
- "type": "string"
- },
- "notes": {
- "description": "Notes of this order.",
- "type": "string"
- },
- "planningTermId": {
- "description": "ID of the terms and conditions template used in this order.",
- "format": "int64",
- "type": "string"
- },
- "projectId": {
- "description": "Project ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "sellerOrderId": {
- "description": "Seller order ID associated with this order.",
- "type": "string"
- },
- "sellerOrganizationName": {
- "description": "Name of the seller organization.",
- "type": "string"
- },
- "siteId": {
- "description": "Site IDs this order is associated with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "siteNames": {
- "description": "Free-form site names this order is associated with.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "subaccountId": {
- "description": "Subaccount ID of this order.",
- "format": "int64",
- "type": "string"
- },
- "termsAndConditions": {
- "description": "Terms and conditions of this order.",
- "type": "string"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OrderContact": {
- "description": "Contact of an order.",
- "id": "OrderContact",
- "properties": {
- "contactInfo": {
- "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.",
- "type": "string"
- },
- "contactName": {
- "description": "Name of this contact.",
- "type": "string"
- },
- "contactTitle": {
- "description": "Title of this contact.",
- "type": "string"
- },
- "contactType": {
- "description": "Type of this contact.",
- "enum": [
- "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
- "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
- "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "signatureUserProfileId": {
- "description": "ID of the user profile containing the signature that will be embedded into order documents.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OrderDocument": {
- "description": "Contains properties of a Planning order document.",
- "id": "OrderDocument",
- "properties": {
- "accountId": {
- "description": "Account ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "amendedOrderDocumentId": {
- "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
- "format": "int64",
- "type": "string"
- },
- "approvedByUserProfileIds": {
- "description": "IDs of users who have approved this order document.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "cancelled": {
- "description": "Whether this order document is cancelled.",
- "type": "boolean"
- },
- "createdInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this order document."
- },
- "effectiveDate": {
- "format": "date",
- "type": "string"
- },
- "id": {
- "description": "ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
- "type": "string"
- },
- "lastSentRecipients": {
- "description": "List of email addresses that received the last sent document.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "lastSentTime": {
- "format": "date-time",
- "type": "string"
- },
- "orderId": {
- "description": "ID of the order from which this order document is created.",
- "format": "int64",
- "type": "string"
- },
- "projectId": {
- "description": "Project ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "signed": {
- "description": "Whether this order document has been signed.",
- "type": "boolean"
- },
- "subaccountId": {
- "description": "Subaccount ID of this order document.",
- "format": "int64",
- "type": "string"
- },
- "title": {
- "description": "Title of this order document.",
- "type": "string"
- },
- "type": {
- "description": "Type of this order document",
- "enum": [
- "PLANNING_ORDER_TYPE_INSERTION_ORDER",
- "PLANNING_ORDER_TYPE_CHANGE_ORDER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "OrderDocumentsListResponse": {
- "description": "Order document List Response",
- "id": "OrderDocumentsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "orderDocuments": {
- "description": "Order document collection",
- "items": {
- "$ref": "OrderDocument"
- },
- "type": "array"
- }
+ "searchString": {
+ "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "OrdersListResponse": {
- "description": "Order List Response",
- "id": "OrdersListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "orders": {
- "description": "Order collection.",
- "items": {
- "$ref": "Order"
- },
- "type": "array"
- }
+ "siteId": {
+ "description": "Select only order documents that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PathFilter": {
- "description": "Represents a DfaReporting path filter.",
- "id": "PathFilter",
- "properties": {
- "eventFilters": {
- "description": "Event filters in path report.",
- "items": {
- "$ref": "EventFilter"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#pathFilter.",
- "type": "string"
- },
- "pathMatchPosition": {
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "PATH_MATCH_POSITION_UNSPECIFIED",
- "ANY",
- "FIRST",
- "LAST"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PathReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH\".",
- "id": "PathReportCompatibleFields",
- "properties": {
- "channelGroupings": {
- "description": "Dimensions which are compatible to be selected in the \"channelGroupings\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "pathFilters": {
- "description": "Dimensions which are compatible to be selected in the \"pathFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "response": {
+ "$ref": "OrderDocumentsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orders": {
+ "methods": {
+ "get": {
+ "description": "Gets one order by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PathReportDimensionValue": {
- "description": "Represents a PathReportDimensionValue resource.",
- "id": "PathReportDimensionValue",
- "properties": {
- "dimensionName": {
- "description": "The name of the dimension.",
- "type": "string"
- },
- "ids": {
- "description": "The possible ID's associated with the value if available.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#pathReportDimensionValue.",
- "type": "string"
- },
- "matchType": {
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "EXACT",
- "BEGINS_WITH",
- "CONTAINS",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "values": {
- "description": "The possible values of the dimension.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PathToConversionReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "id": "PathToConversionReportCompatibleFields",
- "properties": {
- "conversionDimensions": {
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "customFloodlightVariables": {
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "perInteractionDimensions": {
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- }
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "response": {
+ "$ref": "Order"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/projects/{projectId}/orders",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only orders with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "Placement": {
- "description": "Contains properties of a placement.",
- "id": "Placement",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "adBlockingOptOut": {
- "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
- "type": "boolean"
- },
- "additionalSizes": {
- "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "advertiserId": {
- "description": "Advertiser ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this placement is archived.",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Campaign ID of this placement. This field is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "comment": {
- "description": "Comments for this placement.",
- "type": "string"
- },
- "compatibility": {
- "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
- "enum": [
- "DISPLAY",
- "DISPLAY_INTERSTITIAL",
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "IN_STREAM_AUDIO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "contentCategoryId": {
- "description": "ID of the content category assigned to this placement.",
- "format": "int64",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement. This is a read-only field."
- },
- "directorySiteId": {
- "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "description": "External ID for this placement.",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
- },
- "keyName": {
- "description": "Key name of this placement. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this placement."
- },
- "name": {
- "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.",
- "type": "string"
- },
- "paymentApproved": {
- "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
- "type": "boolean"
- },
- "paymentSource": {
- "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "placementGroupId": {
- "description": "ID of this placement's group, if applicable.",
- "format": "int64",
- "type": "string"
- },
- "placementGroupIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
- },
- "placementStrategyId": {
- "description": "ID of the placement strategy assigned to this placement.",
- "format": "int64",
- "type": "string"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
- },
- "primary": {
- "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
- "type": "boolean"
- },
- "publisherUpdateInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the last publisher update. This is a read-only field."
- },
- "siteId": {
- "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
- },
- "sslRequired": {
- "description": "Whether creatives assigned to this placement must be SSL-compliant.",
- "type": "boolean"
- },
- "status": {
- "description": "Third-party placement status.",
- "enum": [
- "PENDING_REVIEW",
- "PAYMENT_ACCEPTED",
- "PAYMENT_REJECTED",
- "ACKNOWLEDGE_REJECTION",
- "ACKNOWLEDGE_ACCEPTANCE",
- "DRAFT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this placement. This field can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "tagFormats": {
- "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
- "items": {
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Tag settings for this placement."
- },
- "videoActiveViewOptOut": {
- "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
- "type": "boolean"
- },
- "videoSettings": {
- "$ref": "VideoSettings",
- "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
- },
- "vpaidAdapterChoice": {
- "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
- "enum": [
- "DEFAULT",
- "FLASH",
- "HTML5",
- "BOTH"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
},
- "type": "object"
- },
- "PlacementAssignment": {
- "description": "Placement Assignment.",
- "id": "PlacementAssignment",
- "properties": {
- "active": {
- "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
- "type": "boolean"
- },
- "placementId": {
- "description": "ID of the placement to be assigned. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "placementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
- },
- "sslRequired": {
- "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
- "type": "boolean"
- }
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PlacementGroup": {
- "description": "Contains properties of a package or roadblock.",
- "id": "PlacementGroup",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this placement group. This is a required field on insertion.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "description": "Whether this placement group is archived.",
- "type": "boolean"
- },
- "campaignId": {
- "description": "Campaign ID of this placement group. This field is required on insertion.",
- "format": "int64",
- "type": "string"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "childPlacementIds": {
- "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "comment": {
- "description": "Comments for this placement group.",
- "type": "string"
- },
- "contentCategoryId": {
- "description": "ID of the content category assigned to this placement group.",
- "format": "int64",
- "type": "string"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement group. This is a read-only field."
- },
- "directorySiteId": {
- "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "description": "External ID for this placement.",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement group. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement group. This is a read-only field."
- },
- "name": {
- "description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
- "type": "string"
- },
- "placementGroupType": {
- "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "placementStrategyId": {
- "description": "ID of the placement strategy assigned to this placement group.",
- "format": "int64",
- "type": "string"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement group. This field is required on insertion."
- },
- "primaryPlacementId": {
- "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
- "format": "int64",
- "type": "string"
- },
- "primaryPlacementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
- },
- "siteId": {
- "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "subaccountId": {
- "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementGroupsListResponse": {
- "description": "Placement Group List Response",
- "id": "PlacementGroupsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placementGroups": {
- "description": "Placement group collection.",
- "items": {
- "$ref": "PlacementGroup"
- },
- "type": "array"
- }
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementStrategiesListResponse": {
- "description": "Placement Strategy List Response",
- "id": "PlacementStrategiesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placementStrategies": {
- "description": "Placement strategy collection.",
- "items": {
- "$ref": "PlacementStrategy"
- },
- "type": "array"
- }
+ "searchString": {
+ "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PlacementStrategy": {
- "description": "Contains properties of a placement strategy.",
- "id": "PlacementStrategy",
- "properties": {
- "accountId": {
- "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
- "type": "string"
- }
+ "siteId": {
+ "description": "Select only orders that are associated with these site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementTag": {
- "description": "Placement Tag",
- "id": "PlacementTag",
- "properties": {
- "placementId": {
- "description": "Placement ID",
- "format": "int64",
- "type": "string"
- },
- "tagDatas": {
- "description": "Tags generated for this placement.",
- "items": {
- "$ref": "TagData"
- },
- "type": "array"
- }
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "type": "object"
- },
- "PlacementsGenerateTagsResponse": {
- "description": "Placement GenerateTags Response",
- "id": "PlacementsGenerateTagsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
- "type": "string"
- },
- "placementTags": {
- "description": "Set of generated tags for the specified placements.",
- "items": {
- "$ref": "PlacementTag"
- },
- "type": "array"
- }
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders",
+ "response": {
+ "$ref": "OrdersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one placement group by ID.",
+ "flatPath": "userprofiles/{profileId}/placementGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlacementsListResponse": {
- "description": "Placement List Response",
- "id": "PlacementsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "placements": {
- "description": "Placement collection.",
- "items": {
- "$ref": "Placement"
- },
- "type": "array"
- }
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups/{id}",
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement group.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placement groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
},
- "type": "object"
- },
- "PlatformType": {
- "description": "Contains information about a platform type that can be targeted by ads.",
- "id": "PlatformType",
- "properties": {
- "id": {
- "description": "ID of this platform type.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this platform type.",
- "type": "string"
- }
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
},
- "type": "object"
- },
- "PlatformTypesListResponse": {
- "description": "Platform Type List Response",
- "id": "PlatformTypesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
- "type": "string"
- },
- "platformTypes": {
- "description": "Platform type collection.",
- "items": {
- "$ref": "PlatformType"
- },
- "type": "array"
- }
+ "campaignIds": {
+ "description": "Select only placement groups that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placement groups that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placement groups that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placement groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "800",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "800",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placement groups that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placement groups with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placement groups that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "response": {
+ "$ref": "PlacementGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement group. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement group.",
+ "flatPath": "userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementStrategies": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.placementStrategies.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement strategy by ID.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies/{id}",
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementStrategies.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only placement strategies with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "response": {
+ "$ref": "PlacementStrategiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement strategy. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementStrategies.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementStrategy ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement strategy.",
+ "flatPath": "userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementStrategies.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placements": {
+ "methods": {
+ "generatetags": {
+ "description": "Generates tags for a placement.",
+ "flatPath": "userprofiles/{profileId}/placements/generatetags",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.generatetags",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Generate placements belonging to this campaign. This is a required field.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Generate tags for these placements.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements/generatetags",
+ "response": {
+ "$ref": "PlacementsGenerateTagsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement by ID.",
+ "flatPath": "userprofiles/{profileId}/placements/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements/{id}",
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placements that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only placements that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibilities": {
+ "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placements that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placements that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "groupIds": {
+ "description": "Select only placements that belong to these placement groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placements with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "paymentSource": {
+ "description": "Select only placements with this payment source.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placements that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placements with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placements that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only placements that are associated with these sizes.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "response": {
+ "$ref": "PlacementsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placements.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement.",
+ "flatPath": "userprofiles/{profileId}/placements",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placements.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "platformTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one platform type by ID.",
+ "flatPath": "userprofiles/{profileId}/platformTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Platform type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/platformTypes/{id}",
+ "response": {
+ "$ref": "PlatformType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of platform types.",
+ "flatPath": "userprofiles/{profileId}/platformTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/platformTypes",
+ "response": {
+ "$ref": "PlatformTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "postalCodes": {
+ "methods": {
+ "get": {
+ "description": "Gets one postal code by ID.",
+ "flatPath": "userprofiles/{profileId}/postalCodes/{code}",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.get",
+ "parameterOrder": [
+ "profileId",
+ "code"
+ ],
+ "parameters": {
+ "code": {
+ "description": "Postal code ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/postalCodes/{code}",
+ "response": {
+ "$ref": "PostalCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of postal codes.",
+ "flatPath": "userprofiles/{profileId}/postalCodes",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/postalCodes",
+ "response": {
+ "$ref": "PostalCodesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "get": {
+ "description": "Gets one project by ID.",
+ "flatPath": "userprofiles/{profileId}/projects/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Project ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects/{id}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
+ "flatPath": "userprofiles/{profileId}/projects",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only projects with these advertiser IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only projects with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/projects",
+ "response": {
+ "$ref": "ProjectsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "regions": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of regions.",
+ "flatPath": "userprofiles/{profileId}/regions",
+ "httpMethod": "GET",
+ "id": "dfareporting.regions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/regions",
+ "response": {
+ "$ref": "RegionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingListShares": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list share by remarketing list ID.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingListShares.get",
+ "parameterOrder": [
+ "profileId",
+ "remarketingListId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list share. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingListShares.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
- "type": "object"
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list share.",
+ "flatPath": "userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingListShares.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists/{id}",
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new remarketing list.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "POST",
+ "id": "dfareporting.remarketingLists.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only remarketing lists owned by this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "floodlightActivityId": {
+ "description": "Select only remarketing lists that have this floodlight activity ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "response": {
+ "$ref": "RemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingLists.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list.",
+ "flatPath": "userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingLists.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a report by its ID.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.reports.delete",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a report by its ID.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "insert": {
+ "description": "Creates a report.",
+ "flatPath": "userprofiles/{profileId}/reports",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of reports.",
+ "flatPath": "userprofiles/{profileId}/reports",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE"
+ ],
+ "enumDescriptions": [
+ "All reports in account.",
+ "My reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "Sort by report ID.",
+ "Sort by 'lastModifiedTime' field.",
+ "Sort by name of reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports",
+ "response": {
+ "$ref": "ReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing report. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.reports.patch",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The DFA user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "run": {
+ "description": "Runs a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/run",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.run",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "synchronous": {
+ "default": "false",
+ "description": "If set and true, tries to run the report synchronously.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/run",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "update": {
+ "description": "Updates a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PUT",
+ "id": "dfareporting.reports.update",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ },
+ "resources": {
+ "compatibleFields": {
+ "methods": {
+ "query": {
+ "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
+ "flatPath": "userprofiles/{profileId}/reports/compatiblefields/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.compatibleFields.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/compatiblefields/query",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "CompatibleFields"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
},
- "PopupWindowProperties": {
- "description": "Popup Window Properties.",
- "id": "PopupWindowProperties",
- "properties": {
- "dimension": {
- "$ref": "Size",
- "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
- },
- "positionType": {
- "description": "Popup window position either centered or at specific coordinate.",
- "enum": [
- "CENTER",
- "COORDINATES"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "showAddressBar": {
- "description": "Whether to display the browser address bar.",
- "type": "boolean"
- },
- "showMenuBar": {
- "description": "Whether to display the browser menu bar.",
- "type": "boolean"
- },
- "showScrollBar": {
- "description": "Whether to display the browser scroll bar.",
- "type": "boolean"
- },
- "showStatusBar": {
- "description": "Whether to display the browser status bar.",
- "type": "boolean"
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "showToolBar": {
- "description": "Whether to display the browser tool bar.",
- "type": "boolean"
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "title": {
- "description": "Title of popup window.",
- "type": "string"
- }
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
},
- "type": "object"
- },
- "PostalCode": {
- "description": "Contains information about a postal code that can be targeted by ads.",
- "id": "PostalCode",
- "properties": {
- "code": {
- "description": "Postal code. This is equivalent to the id field.",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the country to which this postal code belongs.",
- "type": "string"
+ "list": {
+ "description": "Lists files for a report.",
+ "flatPath": "userprofiles/{profileId}/reports/{reportId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.list",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "countryDartId": {
- "description": "DART ID of the country to which this postal code belongs.",
- "format": "int64",
- "type": "string"
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "id": {
- "description": "ID of this postal code.",
- "type": "string"
+ "reportId": {
+ "description": "The ID of the parent report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
},
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
- "type": "string"
- }
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/reports/{reportId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets one site by ID.",
+ "flatPath": "userprofiles/{profileId}/sites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites/{id}",
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new site.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "POST",
+ "id": "dfareporting.sites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only sites that accept publisher paid placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "adWordsSite": {
+ "description": "Select only AdWords sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "approved": {
+ "description": "Select only approved sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only sites with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only sites with these directory site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only sites with this subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "unmappedSite": {
+ "description": "Select only sites that have not been mapped to a directory site.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "response": {
+ "$ref": "SitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing site. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.sites.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing site.",
+ "flatPath": "userprofiles/{profileId}/sites",
+ "httpMethod": "PUT",
+ "id": "dfareporting.sites.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "sizes": {
+ "methods": {
+ "get": {
+ "description": "Gets one size by ID.",
+ "flatPath": "userprofiles/{profileId}/sizes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Size ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes/{id}",
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new size.",
+ "flatPath": "userprofiles/{profileId}/sizes",
+ "httpMethod": "POST",
+ "id": "dfareporting.sizes.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes",
+ "request": {
+ "$ref": "Size"
+ },
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
+ "flatPath": "userprofiles/{profileId}/sizes",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "height": {
+ "description": "Select only sizes with this height.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "iabStandard": {
+ "description": "Select only IAB standard sizes.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only sizes with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "width": {
+ "description": "Select only sizes with this width.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "userprofiles/{profileId}/sizes",
+ "response": {
+ "$ref": "SizesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "subaccounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one subaccount by ID.",
+ "flatPath": "userprofiles/{profileId}/subaccounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts/{id}",
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new subaccount.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "POST",
+ "id": "dfareporting.subaccounts.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only subaccounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "response": {
+ "$ref": "SubaccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing subaccount. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.subaccounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing subaccount.",
+ "flatPath": "userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.subaccounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetableRemarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "response": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/targetableRemarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive targetable remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only targetable remarketing lists targetable by these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetableRemarketingLists",
+ "response": {
+ "$ref": "TargetableRemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetingTemplates": {
+ "methods": {
+ "get": {
+ "description": "Gets one targeting template by ID.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Targeting template ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates/{id}",
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new targeting template.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "POST",
+ "id": "dfareporting.targetingTemplates.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only targeting templates with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only targeting templates with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
},
- "type": "object"
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "response": {
+ "$ref": "TargetingTemplatesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing targeting template. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.targetingTemplates.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "TargetingTemplate ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing targeting template.",
+ "flatPath": "userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PUT",
+ "id": "dfareporting.targetingTemplates.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one user profile by ID.",
+ "flatPath": "userprofiles/{profileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.get",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of user profiles for a user.",
+ "flatPath": "userprofiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.list",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "userprofiles",
+ "response": {
+ "$ref": "UserProfileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission group by ID.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "response": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of all supported user role permission groups.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissionGroups",
+ "response": {
+ "$ref": "UserRolePermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission by ID.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissions/{id}",
+ "response": {
+ "$ref": "UserRolePermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of user role permissions, possibly filtered.",
+ "flatPath": "userprofiles/{profileId}/userRolePermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only user role permissions with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRolePermissions",
+ "response": {
+ "$ref": "UserRolePermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRoles": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.userRoles.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one user role by ID.",
+ "flatPath": "userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles/{id}",
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "POST",
+ "id": "dfareporting.userRoles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "accountUserRoleOnly": {
+ "description": "Select only account level user roles not associated with any specific subaccount.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user roles with the specified IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user roles that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "response": {
+ "$ref": "UserRolesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing user role. This method supports patch semantics.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.userRoles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "UserRole ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing user role.",
+ "flatPath": "userprofiles/{profileId}/userRoles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.userRoles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "videoFormats": {
+ "methods": {
+ "get": {
+ "description": "Gets one video format by ID.",
+ "flatPath": "userprofiles/{profileId}/videoFormats/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Video format ID.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/videoFormats/{id}",
+ "response": {
+ "$ref": "VideoFormat"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Lists available video formats.",
+ "flatPath": "userprofiles/{profileId}/videoFormats",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "userprofiles/{profileId}/videoFormats",
+ "response": {
+ "$ref": "VideoFormatsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210524",
+ "rootUrl": "https://dfareporting.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Contains properties of a Campaign Manager account.",
+ "id": "Account",
+ "properties": {
+ "accountPermissionIds": {
+ "description": "Account permissions assigned to this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "accountProfile": {
+ "description": "Profile for this account. This is a read-only field that can be left blank.",
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this account is active.",
+ "type": "boolean"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for this account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "activeViewOptOut": {
+ "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.",
+ "type": "boolean"
+ },
+ "availablePermissionIds": {
+ "description": "User role permissions available to the user roles of this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "countryId": {
+ "description": "ID of the country associated with this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyId": {
+ "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultCreativeSizeId": {
+ "description": "Default placement dimensions for this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of this account.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this account. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "maximumImageSize": {
+ "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.",
+ "type": "boolean"
+ },
+ "reportsConfiguration": {
+ "$ref": "ReportsConfiguration",
+ "description": "Reporting configuration of this account."
+ },
+ "shareReportsWithTwitter": {
+ "description": "Share Path to Conversion reports with Twitter.",
+ "type": "boolean"
+ },
+ "teaserSizeLimit": {
+ "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountActiveAdSummary": {
+ "description": "Gets a summary of active ads in an account.",
+ "id": "AccountActiveAdSummary",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAds": {
+ "description": "Ads that have been activated for the account",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for the account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "availableAds": {
+ "description": "Ads that can be activated for the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermission": {
+ "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
+ "id": "AccountPermission",
+ "properties": {
+ "accountProfiles": {
+ "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
+ "items": {
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this account permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
+ "type": "string"
+ },
+ "level": {
+ "description": "Administrative level required to enable this account permission.",
+ "enum": [
+ "USER",
+ "ADMINISTRATOR"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "Permission group of this account permission.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroup": {
+ "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
+ "id": "AccountPermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this account permission group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroupsListResponse": {
+ "description": "Account Permission Group List Response",
+ "id": "AccountPermissionGroupsListResponse",
+ "properties": {
+ "accountPermissionGroups": {
+ "description": "Account permission group collection.",
+ "items": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionsListResponse": {
+ "description": "Account Permission List Response",
+ "id": "AccountPermissionsListResponse",
+ "properties": {
+ "accountPermissions": {
+ "description": "Account permission collection.",
+ "items": {
+ "$ref": "AccountPermission"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfile": {
+ "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
+ "id": "AccountUserProfile",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.",
+ "type": "boolean"
+ },
+ "advertiserFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which advertisers are visible to the user profile."
+ },
+ "campaignFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which campaigns are visible to the user profile."
+ },
+ "comments": {
+ "description": "Comments for this user profile.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the user profile. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".",
+ "type": "string"
+ },
+ "siteFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which sites are visible to the user profile."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerType": {
+ "description": "Trafficker type of this user profile. This is a read-only field.",
+ "enum": [
+ "INTERNAL_NON_TRAFFICKER",
+ "INTERNAL_TRAFFICKER",
+ "EXTERNAL_TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userAccessType": {
+ "description": "User type of the user profile. This is a read-only field that can be left blank.",
+ "enum": [
+ "NORMAL_USER",
+ "SUPER_USER",
+ "INTERNAL_ADMINISTRATOR",
+ "READ_ONLY_SUPER_USER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userRoleFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which user roles are visible to the user profile."
+ },
+ "userRoleId": {
+ "description": "User role ID of the user profile. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfilesListResponse": {
+ "description": "Account User Profile List Response",
+ "id": "AccountUserProfilesListResponse",
+ "properties": {
+ "accountUserProfiles": {
+ "description": "Account user profile collection.",
+ "items": {
+ "$ref": "AccountUserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsListResponse": {
+ "description": "Account List Response",
+ "id": "AccountsListResponse",
+ "properties": {
+ "accounts": {
+ "description": "Account collection.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Activities": {
+ "description": "Represents an activity group.",
+ "id": "Activities",
+ "properties": {
+ "filters": {
+ "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#activities.",
+ "type": "string"
+ },
+ "metricNames": {
+ "description": "List of names of floodlight activity metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Ad": {
+ "description": "Contains properties of a Campaign Manager ad.",
+ "id": "Ad",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this ad is active. When true, archived must be false.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this ad is archived. When true, active must be false.",
+ "type": "boolean"
+ },
+ "audienceSegmentId": {
+ "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
+ },
+ "comments": {
+ "description": "Comments for this ad.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this ad. This is a read-only field."
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeRotation": {
+ "$ref": "CreativeRotation",
+ "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Default click-through event tag properties for this ad."
+ },
+ "deliverySchedule": {
+ "$ref": "DeliverySchedule",
+ "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
+ },
+ "dynamicClickTracker": {
+ "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Event tag overrides for this ad.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "id": {
+ "description": "ID of this ad. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this ad. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this ad. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementAssignments": {
+ "description": "Placement assignments for this ad.",
+ "items": {
+ "$ref": "PlacementAssignment"
+ },
+ "type": "array"
+ },
+ "remarketingListExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
+ },
+ "sslCompliant": {
+ "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "type": {
+ "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdBlockingConfiguration": {
+ "description": "Campaign ad blocking settings.",
+ "id": "AdBlockingConfiguration",
+ "properties": {
+ "clickThroughUrl": {
+ "description": "Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.",
+ "type": "string"
+ },
+ "creativeBundleId": {
+ "description": "ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.",
+ "format": "int64",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.",
+ "type": "boolean"
+ },
+ "overrideClickThroughUrl": {
+ "description": "Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdSlot": {
+ "description": "Ad Slot",
+ "id": "AdSlot",
+ "properties": {
+ "comment": {
+ "description": "Comment for this ad slot.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "height": {
+ "description": "Height of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "linkedPlacementId": {
+ "description": "ID of the placement from an external platform that is linked to this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this ad slot.",
+ "type": "string"
+ },
+ "paymentSourceType": {
+ "description": "Payment source type of this ad slot.",
+ "enum": [
+ "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
+ "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "primary": {
+ "description": "Primary ad slot of a roadblock inventory item.",
+ "type": "boolean"
+ },
+ "width": {
+ "description": "Width of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdsListResponse": {
+ "description": "Ad List Response",
+ "id": "AdsListResponse",
+ "properties": {
+ "ads": {
+ "description": "Ad collection.",
+ "items": {
+ "$ref": "Ad"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Advertiser": {
+ "description": "Contains properties of a Campaign Manager advertiser.",
+ "id": "Advertiser",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserGroupId": {
+ "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickThroughUrlSuffix": {
+ "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
+ "type": "string"
+ },
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultEmail": {
+ "description": "Default email address used in sender field for tag emails.",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this advertiser. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
+ "type": "string"
+ },
+ "originalFloodlightConfigurationId": {
+ "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this advertiser.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "suspended": {
+ "description": "Suspension status of this advertiser.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroup": {
+ "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
+ "id": "AdvertiserGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroupsListResponse": {
+ "description": "Advertiser Group List Response",
+ "id": "AdvertiserGroupsListResponse",
+ "properties": {
+ "advertiserGroups": {
+ "description": "Advertiser group collection.",
+ "items": {
+ "$ref": "AdvertiserGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserLandingPagesListResponse": {
+ "description": "Landing Page List Response",
+ "id": "AdvertiserLandingPagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
+ "type": "string"
+ },
+ "landingPages": {
+ "description": "Landing page collection",
+ "items": {
+ "$ref": "LandingPage"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertisersListResponse": {
+ "description": "Advertiser List Response",
+ "id": "AdvertisersListResponse",
+ "properties": {
+ "advertisers": {
+ "description": "Advertiser collection.",
+ "items": {
+ "$ref": "Advertiser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegment": {
+ "description": "Audience Segment.",
+ "id": "AudienceSegment",
+ "properties": {
+ "allocation": {
+ "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this audience segment. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegmentGroup": {
+ "description": "Audience Segment Group.",
+ "id": "AudienceSegmentGroup",
+ "properties": {
+ "audienceSegments": {
+ "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
+ "items": {
+ "$ref": "AudienceSegment"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Browser": {
+ "description": "Contains information about a browser that can be targeted by ads.",
+ "id": "Browser",
+ "properties": {
+ "browserVersionId": {
+ "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this browser. This is the ID used when generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BrowsersListResponse": {
+ "description": "Browser List Response",
+ "id": "BrowsersListResponse",
+ "properties": {
+ "browsers": {
+ "description": "Browser collection.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Campaign": {
+ "description": "Contains properties of a Campaign Manager campaign.",
+ "id": "Campaign",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingConfiguration": {
+ "$ref": "AdBlockingConfiguration",
+ "description": "Ad blocking settings for this campaign."
+ },
+ "additionalCreativeOptimizationConfigurations": {
+ "description": "Additional creative optimization configurations for the campaign.",
+ "items": {
+ "$ref": "CreativeOptimizationConfiguration"
+ },
+ "type": "array"
+ },
+ "advertiserGroupId": {
+ "description": "Advertiser group ID of the associated advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this campaign has been archived.",
+ "type": "boolean"
+ },
+ "audienceSegmentGroups": {
+ "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
+ "items": {
+ "$ref": "AudienceSegmentGroup"
+ },
+ "type": "array"
+ },
+ "billingInvoiceCode": {
+ "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.",
+ "type": "string"
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix override properties for this campaign."
+ },
+ "comment": {
+ "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this campaign. This is a read-only field."
+ },
+ "creativeGroupIds": {
+ "description": "List of creative group IDs that are assigned to the campaign.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfiguration": {
+ "$ref": "CreativeOptimizationConfiguration",
+ "description": "Creative optimization configuration for the campaign."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Click-through event tag ID override properties for this campaign."
+ },
+ "defaultLandingPageId": {
+ "description": "The default landing page ID for this campaign.",
+ "format": "int64",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "externalId": {
+ "description": "External ID for this campaign.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this campaign. This is a read-only auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this campaign. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether Nielsen reports are enabled for this campaign.",
+ "type": "boolean"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerEmails": {
+ "description": "Campaign trafficker contact emails.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociation": {
+ "description": "Identifies a creative which has been associated with a given campaign.",
+ "id": "CampaignCreativeAssociation",
+ "properties": {
+ "creativeId": {
+ "description": "ID of the creative associated with the campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociationsListResponse": {
+ "description": "Campaign Creative Association List Response",
+ "id": "CampaignCreativeAssociationsListResponse",
+ "properties": {
+ "campaignCreativeAssociations": {
+ "description": "Campaign creative association collection",
+ "items": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignManagerIds": {
+ "description": "Campaign Manager IDs related to the custom event.",
+ "id": "CampaignManagerIds",
+ "properties": {
+ "adId": {
+ "description": "Ad ID for Campaign Manager.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignId": {
+ "description": "Campaign ID for Campaign Manager.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "Creative ID for Campaign Manager.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignManagerIds\".",
+ "type": "string"
+ },
+ "placementId": {
+ "description": "Placement ID for Campaign Manager.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Site ID for Campaign Manager.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignsListResponse": {
+ "description": "Campaign List Response",
+ "id": "CampaignsListResponse",
+ "properties": {
+ "campaigns": {
+ "description": "Campaign collection.",
+ "items": {
+ "$ref": "Campaign"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLog": {
+ "description": "Describes a change that a user has made to a resource.",
+ "id": "ChangeLog",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "action": {
+ "description": "Action which caused the change.",
+ "type": "string"
+ },
+ "changeTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "fieldName": {
+ "description": "Field name of the object which changed.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this change log.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
+ "type": "string"
+ },
+ "newValue": {
+ "description": "New value of the object field.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Object type of the change log.",
+ "type": "string"
+ },
+ "oldValue": {
+ "description": "Old value of the object field.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transactionId": {
+ "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileId": {
+ "description": "ID of the user who modified the object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileName": {
+ "description": "User profile name of the user who modified the object.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLogsListResponse": {
+ "description": "Change Log List Response",
+ "id": "ChangeLogsListResponse",
+ "properties": {
+ "changeLogs": {
+ "description": "Change log collection.",
+ "items": {
+ "$ref": "ChangeLog"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChannelGrouping": {
+ "description": "Represents a DfaReporting channel grouping.",
+ "id": "ChannelGrouping",
+ "properties": {
+ "fallbackName": {
+ "description": "ChannelGrouping fallback name.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#channelGrouping.",
+ "type": "string"
+ },
+ "name": {
+ "description": "ChannelGrouping name.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "The rules contained within this channel grouping.",
+ "items": {
+ "$ref": "ChannelGroupingRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ChannelGroupingRule": {
+ "description": "Represents a DfaReporting channel grouping rule.",
+ "id": "ChannelGroupingRule",
+ "properties": {
+ "disjunctiveMatchStatements": {
+ "description": "The disjunctive match statements contained within this rule.",
+ "items": {
+ "$ref": "DisjunctiveMatchStatement"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#channelGroupingRule.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Rule name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CitiesListResponse": {
+ "description": "City List Response",
+ "id": "CitiesListResponse",
+ "properties": {
+ "cities": {
+ "description": "City collection.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "City": {
+ "description": "Contains information about a city that can be targeted by ads.",
+ "id": "City",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this city belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro region code of the metro region (DMA) to which this city belongs.",
+ "type": "string"
+ },
+ "metroDmaId": {
+ "description": "ID of the metro region (DMA) to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this city.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code of the region to which this city belongs.",
+ "type": "string"
+ },
+ "regionDartId": {
+ "description": "DART ID of the region to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickTag": {
+ "description": "Creative Click Tag.",
+ "id": "ClickTag",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Parameter value for the specified click tag. This field contains a click-through url."
+ },
+ "eventName": {
+ "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "ClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "defaultLandingPage": {
+ "description": "Whether the campaign default landing page is used.",
+ "type": "boolean"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrlSuffixProperties": {
+ "description": "Click Through URL Suffix settings.",
+ "id": "ClickThroughUrlSuffixProperties",
+ "properties": {
+ "clickThroughUrlSuffix": {
+ "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
+ "type": "string"
+ },
+ "overrideInheritedSuffix": {
+ "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionClickThroughOverride": {
+ "description": "Companion Click-through override.",
+ "id": "CompanionClickThroughOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this companion click-through override."
+ },
+ "creativeId": {
+ "description": "ID of the creative for this companion click-through override.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionSetting": {
+ "description": "Companion Settings",
+ "id": "CompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this placement.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompatibleFields": {
+ "description": "Represents a response to the queryCompatibleFields method.",
+ "id": "CompatibleFields",
+ "properties": {
+ "crossDimensionReachReportCompatibleFields": {
+ "$ref": "CrossDimensionReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
+ },
+ "floodlightReportCompatibleFields": {
+ "$ref": "FloodlightReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
+ "type": "string"
+ },
+ "pathAttributionReportCompatibleFields": {
+ "$ref": "PathReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH_ATTRIBUTION\"."
+ },
+ "pathReportCompatibleFields": {
+ "$ref": "PathReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH\"."
+ },
+ "pathToConversionReportCompatibleFields": {
+ "$ref": "PathToConversionReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
+ },
+ "reachReportCompatibleFields": {
+ "$ref": "ReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
+ },
+ "reportCompatibleFields": {
+ "$ref": "ReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionType": {
+ "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
+ "id": "ConnectionType",
+ "properties": {
+ "id": {
+ "description": "ID of this connection type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this connection type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionTypesListResponse": {
+ "description": "Connection Type List Response",
+ "id": "ConnectionTypesListResponse",
+ "properties": {
+ "connectionTypes": {
+ "description": "Collection of connection types such as broadband and mobile.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategoriesListResponse": {
+ "description": "Content Category List Response",
+ "id": "ContentCategoriesListResponse",
+ "properties": {
+ "contentCategories": {
+ "description": "Content category collection.",
+ "items": {
+ "$ref": "ContentCategory"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategory": {
+ "description": "Organizes placements according to the contents of their associated webpages.",
+ "id": "ContentCategory",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this content category. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this content category. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Conversion": {
+ "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
+ "id": "Conversion",
+ "properties": {
+ "childDirectedTreatment": {
+ "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
+ "type": "boolean"
+ },
+ "customVariables": {
+ "description": "Custom floodlight variables.",
+ "items": {
+ "$ref": "CustomFloodlightVariable"
+ },
+ "type": "array"
+ },
+ "dclid": {
+ "description": "The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
+ "type": "string"
+ },
+ "encryptedUserId": {
+ "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "encryptedUserIdCandidates": {
+ "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight Activity ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight Configuration ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "gclid": {
+ "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
+ "type": "string"
+ },
+ "limitAdTracking": {
+ "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
+ "type": "boolean"
+ },
+ "matchId": {
+ "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "mobileDeviceId": {
+ "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "nonPersonalizedAd": {
+ "description": "Whether the conversion was for a non personalized ad.",
+ "type": "boolean"
+ },
+ "ordinal": {
+ "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity of the conversion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timestampMicros": {
+ "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "treatmentForUnderage": {
+ "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The value of the conversion.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionError": {
+ "description": "The error code and description for a conversion that failed to insert or update.",
+ "id": "ConversionError",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "INVALID_ARGUMENT",
+ "INTERNAL",
+ "PERMISSION_DENIED",
+ "NOT_FOUND"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
+ "type": "string"
+ },
+ "message": {
+ "description": "A description of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionStatus": {
+ "description": "The original conversion that was inserted or updated and whether there were any errors.",
+ "id": "ConversionStatus",
+ "properties": {
+ "conversion": {
+ "$ref": "Conversion",
+ "description": "The original conversion that was inserted or updated."
+ },
+ "errors": {
+ "description": "A list of errors related to this conversion.",
+ "items": {
+ "$ref": "ConversionError"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertRequest": {
+ "description": "Insert Conversions Request.",
+ "id": "ConversionsBatchInsertRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to insert.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertResponse": {
+ "description": "Insert Conversions Response.",
+ "id": "ConversionsBatchInsertResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to insert.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateRequest": {
+ "description": "Update Conversions Request.",
+ "id": "ConversionsBatchUpdateRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to update.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateResponse": {
+ "description": "Update Conversions Response.",
+ "id": "ConversionsBatchUpdateResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to update.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CountriesListResponse": {
+ "description": "Country List Response",
+ "id": "CountriesListResponse",
+ "properties": {
+ "countries": {
+ "description": "Country collection.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Country": {
+ "description": "Contains information about a country that can be targeted by ads.",
+ "id": "Country",
+ "properties": {
+ "countryCode": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this country.",
+ "type": "string"
+ },
+ "sslEnabled": {
+ "description": "Whether ad serving supports secure servers in this country.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Creative": {
+ "description": "Contains properties of a Creative.",
+ "id": "Creative",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether the creative is active. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "adParameters": {
+ "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "type": "string"
+ },
+ "adTagKeys": {
+ "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "allowScriptAccess": {
+ "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "boolean"
+ },
+ "archived": {
+ "description": "Whether the creative is archived. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "artworkType": {
+ "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringSource": {
+ "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
+ "enum": [
+ "CREATIVE_AUTHORING_SOURCE_DCM",
+ "CREATIVE_AUTHORING_SOURCE_DBM",
+ "CREATIVE_AUTHORING_SOURCE_STUDIO",
+ "CREATIVE_AUTHORING_SOURCE_GWD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringTool": {
+ "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "enum": [
+ "NINJA",
+ "SWIFFY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "autoAdvanceImages": {
+ "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
+ "type": "boolean"
+ },
+ "backgroundColor": {
+ "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "string"
+ },
+ "backupImageClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE."
+ },
+ "backupImageFeatures": {
+ "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "backupImageReportingLabel": {
+ "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "backupImageTargetWindow": {
+ "$ref": "TargetWindow",
+ "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "clickTags": {
+ "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "commercialId": {
+ "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.",
+ "type": "string"
+ },
+ "companionCreatives": {
+ "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibility": {
+ "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "convertFlashToHtml5": {
+ "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "counterCustomEvents": {
+ "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "creativeAssetSelection": {
+ "$ref": "CreativeAssetSelection",
+ "description": "Required if dynamicAssetSelection is true."
+ },
+ "creativeAssets": {
+ "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
+ "items": {
+ "$ref": "CreativeAsset"
+ },
+ "type": "array"
+ },
+ "creativeFieldAssignments": {
+ "description": "Creative field assignments for this creative. Applicable to all creative types.",
+ "items": {
+ "$ref": "CreativeFieldAssignment"
+ },
+ "type": "array"
+ },
+ "customKeyValues": {
+ "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dynamicAssetSelection": {
+ "description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.",
+ "type": "boolean"
+ },
+ "exitCustomEvents": {
+ "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "fsCommand": {
+ "$ref": "FsCommand",
+ "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
+ },
+ "htmlCode": {
+ "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
+ "type": "string"
+ },
+ "htmlCodeLocked": {
+ "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
+ },
+ "latestTraffickedCreativeId": {
+ "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "mediaDescription": {
+ "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
+ "type": "string"
+ },
+ "mediaDuration": {
+ "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "name": {
+ "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.",
+ "type": "string"
+ },
+ "obaIcon": {
+ "$ref": "ObaIcon",
+ "description": "Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "overrideCss": {
+ "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "redirectUrl": {
+ "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT",
+ "type": "string"
+ },
+ "renderingId": {
+ "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "renderingIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "requiredFlashPluginVersion": {
+ "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "type": "string"
+ },
+ "requiredFlashVersion": {
+ "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "skippable": {
+ "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "sslOverride": {
+ "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "studioAdvertiserId": {
+ "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioCreativeId": {
+ "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioTraffickedCreativeId": {
+ "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "thirdPartyBackupImageImpressionsUrl": {
+ "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyRichMediaImpressionsUrl": {
+ "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyUrls": {
+ "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
+ "items": {
+ "$ref": "ThirdPartyTrackingUrl"
+ },
+ "type": "array"
+ },
+ "timerCustomEvents": {
+ "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "totalFileSize": {
+ "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "universalAdId": {
+ "$ref": "UniversalAdId",
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
+ },
+ "version": {
+ "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAsset": {
+ "description": "Creative Asset.",
+ "id": "CreativeAsset",
+ "properties": {
+ "actionScript3": {
+ "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "active": {
+ "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "alignment": {
+ "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .",
+ "enum": [
+ "ALIGNMENT_TOP",
+ "ALIGNMENT_RIGHT",
+ "ALIGNMENT_BOTTOM",
+ "ALIGNMENT_LEFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
+ },
+ "audioBitRate": {
+ "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "audioSampleRate": {
+ "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "backupImageExit": {
+ "$ref": "CreativeCustomEvent",
+ "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "bitRate": {
+ "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "childAssetType": {
+ "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "enum": [
+ "CHILD_ASSET_TYPE_FLASH",
+ "CHILD_ASSET_TYPE_VIDEO",
+ "CHILD_ASSET_TYPE_IMAGE",
+ "CHILD_ASSET_TYPE_DATA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "collapsedSize": {
+ "$ref": "Size",
+ "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "companionCreativeIds": {
+ "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "customStartTimeValue": {
+ "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "displayType": {
+ "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DISPLAY_TYPE_INPAGE",
+ "ASSET_DISPLAY_TYPE_FLOATING",
+ "ASSET_DISPLAY_TYPE_OVERLAY",
+ "ASSET_DISPLAY_TYPE_EXPANDING",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
+ "ASSET_DISPLAY_TYPE_PEEL_DOWN",
+ "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
+ "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
+ "ASSET_DISPLAY_TYPE_BACKDROP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "duration": {
+ "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "durationType": {
+ "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DURATION_TYPE_AUTO",
+ "ASSET_DURATION_TYPE_NONE",
+ "ASSET_DURATION_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "expandedDimension": {
+ "$ref": "Size",
+ "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
+ },
+ "fileSize": {
+ "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "flashVersion": {
+ "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frameRate": {
+ "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "hideFlashObjects": {
+ "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "hideSelectionBoxes": {
+ "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "horizontallyLocked": {
+ "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
+ },
+ "mediaDuration": {
+ "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "mimeType": {
+ "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "orientation": {
+ "description": "Orientation of video asset. This is a read-only, auto-generated field.",
+ "enum": [
+ "LANDSCAPE",
+ "PORTRAIT",
+ "SQUARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "originalBackup": {
+ "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "politeLoad": {
+ "description": "Whether this asset is used as a polite load asset.",
+ "type": "boolean"
+ },
+ "position": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "positionLeftUnit": {
+ "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "positionTopUnit": {
+ "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "progressiveServingUrl": {
+ "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "pushdown": {
+ "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
+ "type": "boolean"
+ },
+ "pushdownDuration": {
+ "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
+ "format": "float",
+ "type": "number"
+ },
+ "role": {
+ "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
+ "enum": [
+ "PRIMARY",
+ "BACKUP_IMAGE",
+ "ADDITIONAL_IMAGE",
+ "ADDITIONAL_FLASH",
+ "PARENT_VIDEO",
+ "TRANSCODED_VIDEO",
+ "OTHER",
+ "ALTERNATE_VIDEO",
+ "PARENT_AUDIO",
+ "TRANSCODED_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "sslCompliant": {
+ "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "type": "boolean"
+ },
+ "startTimeType": {
+ "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_START_TIME_TYPE_NONE",
+ "ASSET_START_TIME_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "streamingServingUrl": {
+ "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "transparency": {
+ "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.",
+ "type": "boolean"
+ },
+ "verticallyLocked": {
+ "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "windowMode": {
+ "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
+ "enum": [
+ "OPAQUE",
+ "WINDOW",
+ "TRANSPARENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "zIndex": {
+ "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "zipFilename": {
+ "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ },
+ "zipFilesize": {
+ "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetId": {
+ "description": "Creative Asset ID.",
+ "id": "CreativeAssetId",
+ "properties": {
+ "name": {
+ "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
+ "enum": [
+ "IMAGE",
+ "FLASH",
+ "VIDEO",
+ "HTML",
+ "HTML_IMAGE",
+ "AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetMetadata": {
+ "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
+ "id": "CreativeAssetMetadata",
+ "properties": {
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "ID of the creative asset. This is a required field."
+ },
+ "clickTags": {
+ "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "counterCustomEvents": {
+ "description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "exitCustomEvents": {
+ "description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
+ "type": "string"
+ },
+ "richMedia": {
+ "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.",
+ "type": "boolean"
+ },
+ "timerCustomEvents": {
+ "description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "warnedValidationRules": {
+ "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
+ "items": {
+ "enum": [
+ "CLICK_TAG_NON_TOP_LEVEL",
+ "CLICK_TAG_MISSING",
+ "CLICK_TAG_MORE_THAN_ONE",
+ "CLICK_TAG_INVALID",
+ "ORPHANED_ASSET",
+ "PRIMARY_HTML_MISSING",
+ "EXTERNAL_FILE_REFERENCED",
+ "MRAID_REFERENCED",
+ "ADMOB_REFERENCED",
+ "FILE_TYPE_INVALID",
+ "ZIP_INVALID",
+ "LINKED_FILE_NOT_FOUND",
+ "MAX_FLASH_VERSION_11",
+ "NOT_SSL_COMPLIANT",
+ "FILE_DETAIL_EMPTY",
+ "ASSET_INVALID",
+ "GWD_PROPERTIES_INVALID",
+ "ENABLER_UNSUPPORTED_METHOD_DCM",
+ "ASSET_FORMAT_UNSUPPORTED_DCM",
+ "COMPONENT_UNSUPPORTED_DCM",
+ "HTML5_FEATURE_UNSUPPORTED",
+ "CLICK_TAG_IN_GWD",
+ "CLICK_TAG_HARD_CODED",
+ "SVG_INVALID",
+ "CLICK_TAG_IN_RICH_MEDIA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetSelection": {
+ "description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "CreativeAssetSelection",
+ "properties": {
+ "defaultAssetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rules": {
+ "description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssignment": {
+ "description": "Creative Assignment.",
+ "id": "CreativeAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "applyEventTags": {
+ "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
+ "type": "boolean"
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of the creative assignment."
+ },
+ "companionCreativeOverrides": {
+ "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
+ "items": {
+ "$ref": "CompanionClickThroughOverride"
+ },
+ "type": "array"
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeId": {
+ "description": "ID of the creative to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "richMediaExitOverrides": {
+ "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
+ "items": {
+ "$ref": "RichMediaExitOverride"
+ },
+ "type": "array"
+ },
+ "sequence": {
+ "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "weight": {
+ "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "CreativeClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeCustomEvent": {
+ "description": "Creative Custom Event.",
+ "id": "CreativeCustomEvent",
+ "properties": {
+ "advertiserCustomEventId": {
+ "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserCustomEventName": {
+ "description": "User-entered name for the event.",
+ "type": "string"
+ },
+ "advertiserCustomEventType": {
+ "description": "Type of the event. This is a read-only field.",
+ "enum": [
+ "ADVERTISER_EVENT_TIMER",
+ "ADVERTISER_EVENT_EXIT",
+ "ADVERTISER_EVENT_COUNTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkLabel": {
+ "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type used by the creative.This is a read-only field.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "exitClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Exit click-through URL for the event. This field is used only for exit events."
+ },
+ "id": {
+ "description": "ID of this event. This is a required field and should not be modified after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "popupWindowProperties": {
+ "$ref": "PopupWindowProperties",
+ "description": "Properties for rich media popup windows. This field is used only for exit events."
+ },
+ "targetType": {
+ "description": "Target type used by the event.",
+ "enum": [
+ "TARGET_BLANK",
+ "TARGET_TOP",
+ "TARGET_SELF",
+ "TARGET_PARENT",
+ "TARGET_POPUP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "videoReportingId": {
+ "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeField": {
+ "description": "Contains properties of a creative field.",
+ "id": "CreativeField",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative field. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this creative field. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldAssignment": {
+ "description": "Creative Field Assignment.",
+ "id": "CreativeFieldAssignment",
+ "properties": {
+ "creativeFieldId": {
+ "description": "ID of the creative field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeFieldValueId": {
+ "description": "ID of the creative field value.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValue": {
+ "description": "Contains properties of a creative field value.",
+ "id": "CreativeFieldValue",
+ "properties": {
+ "id": {
+ "description": "ID of this creative field value. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValuesListResponse": {
+ "description": "Creative Field Value List Response",
+ "id": "CreativeFieldValuesListResponse",
+ "properties": {
+ "creativeFieldValues": {
+ "description": "Creative field value collection.",
+ "items": {
+ "$ref": "CreativeFieldValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldsListResponse": {
+ "description": "Creative Field List Response",
+ "id": "CreativeFieldsListResponse",
+ "properties": {
+ "creativeFields": {
+ "description": "Creative field collection.",
+ "items": {
+ "$ref": "CreativeField"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroup": {
+ "description": "Contains properties of a creative group.",
+ "id": "CreativeGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "groupNumber": {
+ "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this creative group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupAssignment": {
+ "description": "Creative Group Assignment.",
+ "id": "CreativeGroupAssignment",
+ "properties": {
+ "creativeGroupId": {
+ "description": "ID of the creative group to be assigned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeGroupNumber": {
+ "description": "Creative group number of the creative group assignment.",
+ "enum": [
+ "CREATIVE_GROUP_ONE",
+ "CREATIVE_GROUP_TWO"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupsListResponse": {
+ "description": "Creative Group List Response",
+ "id": "CreativeGroupsListResponse",
+ "properties": {
+ "creativeGroups": {
+ "description": "Creative group collection.",
+ "items": {
+ "$ref": "CreativeGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeOptimizationConfiguration": {
+ "description": "Creative optimization settings.",
+ "id": "CreativeOptimizationConfiguration",
+ "properties": {
+ "id": {
+ "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.",
+ "type": "string"
+ },
+ "optimizationActivitys": {
+ "description": "List of optimization activities associated with this configuration.",
+ "items": {
+ "$ref": "OptimizationActivity"
+ },
+ "type": "array"
+ },
+ "optimizationModel": {
+ "description": "Optimization model for this configuration.",
+ "enum": [
+ "CLICK",
+ "POST_CLICK",
+ "POST_IMPRESSION",
+ "POST_CLICK_AND_IMPRESSION",
+ "VIDEO_COMPLETION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeRotation": {
+ "description": "Creative Rotation.",
+ "id": "CreativeRotation",
+ "properties": {
+ "creativeAssignments": {
+ "description": "Creative assignments in this creative rotation.",
+ "items": {
+ "$ref": "CreativeAssignment"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfigurationId": {
+ "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
+ "enum": [
+ "CREATIVE_ROTATION_TYPE_SEQUENTIAL",
+ "CREATIVE_ROTATION_TYPE_RANDOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "weightCalculationStrategy": {
+ "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
+ "enum": [
+ "WEIGHT_STRATEGY_EQUAL",
+ "WEIGHT_STRATEGY_CUSTOM",
+ "WEIGHT_STRATEGY_HIGHEST_CTR",
+ "WEIGHT_STRATEGY_OPTIMIZED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativesListResponse": {
+ "description": "Creative List Response",
+ "id": "CreativesListResponse",
+ "properties": {
+ "creatives": {
+ "description": "Creative collection.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CrossDimensionReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
+ "id": "CrossDimensionReachReportCompatibleFields",
+ "properties": {
+ "breakdown": {
+ "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "overlapMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEvent": {
+ "description": "Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.",
+ "id": "CustomEvent",
+ "properties": {
+ "annotateClickEvent": {
+ "$ref": "CustomEventClickAnnotation",
+ "description": "Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field."
+ },
+ "annotateImpressionEvent": {
+ "$ref": "CustomEventImpressionAnnotation",
+ "description": "Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field."
+ },
+ "customVariables": {
+ "description": "Custom variables associated with the event.",
+ "items": {
+ "$ref": "CustomVariable"
+ },
+ "type": "array"
+ },
+ "eventType": {
+ "description": "The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated.",
+ "enum": [
+ "UNKNOWN",
+ "INSERT",
+ "ANNOTATE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of the advertiser the event is linked to. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "insertEvent": {
+ "$ref": "CustomEventInsert",
+ "description": "Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEvent\".",
+ "type": "string"
+ },
+ "ordinal": {
+ "description": "The ordinal of this custom event. This is a required field.",
+ "type": "string"
+ },
+ "timestampMicros": {
+ "description": "The timestamp of this custom event, in Unix epoch micros. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventClickAnnotation": {
+ "description": "Annotate a click event.",
+ "id": "CustomEventClickAnnotation",
+ "properties": {
+ "gclid": {
+ "description": "The Google click ID. Use this field to annotate the click associated with the gclid.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventClickAnnotation\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventError": {
+ "description": "The error code and description for a custom event that failed to insert.",
+ "id": "CustomEventError",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "UNKNOWN",
+ "INVALID_ARGUMENT",
+ "INTERNAL",
+ "PERMISSION_DENIED",
+ "NOT_FOUND"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventError\".",
+ "type": "string"
+ },
+ "message": {
+ "description": "A description of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventImpressionAnnotation": {
+ "description": "Annotate an impression.",
+ "id": "CustomEventImpressionAnnotation",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventImpressionAnnotation\".",
+ "type": "string"
+ },
+ "pathImpressionId": {
+ "description": "The path impression ID. Use this field to annotate the impression associated with the pathImpressionId.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventInsert": {
+ "description": "Custom event to be inserted.",
+ "id": "CustomEventInsert",
+ "properties": {
+ "cmDimensions": {
+ "$ref": "CampaignManagerIds",
+ "description": "Campaign Manager dimensions associated with the event."
+ },
+ "dv3Dimensions": {
+ "$ref": "DV3Ids",
+ "description": "DV360 dimensions associated with the event."
+ },
+ "insertEventType": {
+ "description": "The type of event to insert.",
+ "enum": [
+ "UNKNOWN",
+ "IMPRESSION",
+ "CLICK"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventInsert\".",
+ "type": "string"
+ },
+ "matchId": {
+ "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required.",
+ "type": "string"
+ },
+ "mobileDeviceId": {
+ "description": "The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventStatus": {
+ "description": "The original custom event that was inserted and whether there were any errors.",
+ "id": "CustomEventStatus",
+ "properties": {
+ "customEvent": {
+ "$ref": "CustomEvent",
+ "description": "The original custom event that was inserted."
+ },
+ "errors": {
+ "description": "A list of errors related to this custom event.",
+ "items": {
+ "$ref": "CustomEventError"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventStatus\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventsBatchInsertRequest": {
+ "description": "Insert Custom Events Request.",
+ "id": "CustomEventsBatchInsertRequest",
+ "properties": {
+ "customEvents": {
+ "description": "The set of custom events to insert.",
+ "items": {
+ "$ref": "CustomEvent"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomEventsBatchInsertResponse": {
+ "description": "Insert Custom Events Response.",
+ "id": "CustomEventsBatchInsertResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all custom events failed to insert.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The insert status of each custom event. Statuses are returned in the same order that conversions are inserted.",
+ "items": {
+ "$ref": "CustomEventStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomFloodlightVariable": {
+ "description": "A custom floodlight variable.",
+ "id": "CustomFloodlightVariable",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomRichMediaEvents": {
+ "description": "Represents a Custom Rich Media Events group.",
+ "id": "CustomRichMediaEvents",
+ "properties": {
+ "filteredEventIds": {
+ "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomVariable": {
+ "description": "Custom variable.",
+ "id": "CustomVariable",
+ "properties": {
+ "index": {
+ "description": "The index of the custom variable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customVariable\".",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the custom variable. The length of string must not exceed 50 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetric": {
+ "description": "Custom Viewability Metric",
+ "id": "CustomViewabilityMetric",
+ "properties": {
+ "configuration": {
+ "$ref": "CustomViewabilityMetricConfiguration",
+ "description": "Configuration of the custom viewability metric."
+ },
+ "id": {
+ "description": "ID of the custom viewability metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the custom viewability metric.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetricConfiguration": {
+ "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
+ "id": "CustomViewabilityMetricConfiguration",
+ "properties": {
+ "audible": {
+ "description": "Whether the video must be audible to count an impression.",
+ "type": "boolean"
+ },
+ "timeMillis": {
+ "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "timePercent": {
+ "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "viewabilityPercent": {
+ "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DV3Ids": {
+ "description": "DV360 IDs related to the custom event.",
+ "id": "DV3Ids",
+ "properties": {
+ "dvCampaignId": {
+ "description": "Campaign ID for DV360.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dvCreativeId": {
+ "description": "Creative ID for DV360.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dvInsertionOrderId": {
+ "description": "Insertion Order ID for DV360.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dvLineItemId": {
+ "description": "Line Item ID for DV360.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dvSiteId": {
+ "description": "Site ID for DV360.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dV3Ids\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "Represents a date range.",
+ "id": "DateRange",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dateRange.",
+ "type": "string"
+ },
+ "relativeDateRange": {
+ "description": "The date range relative to the date of when the report is run.",
+ "enum": [
+ "TODAY",
+ "YESTERDAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "LAST_24_MONTHS",
+ "LAST_14_DAYS",
+ "LAST_60_DAYS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DayPartTargeting": {
+ "description": "Day Part Targeting.",
+ "id": "DayPartTargeting",
+ "properties": {
+ "daysOfWeek": {
+ "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ",
+ "items": {
+ "enum": [
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hoursOfDay": {
+ "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "userLocalTime": {
+ "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeepLink": {
+ "description": "Contains information about a landing page deep link.",
+ "id": "DeepLink",
+ "properties": {
+ "appUrl": {
+ "description": "The URL of the mobile app being linked to.",
+ "type": "string"
+ },
+ "fallbackUrl": {
+ "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".",
+ "type": "string"
+ },
+ "mobileApp": {
+ "$ref": "MobileApp",
+ "description": "The mobile app targeted by this deep link."
+ },
+ "remarketingListIds": {
+ "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DefaultClickThroughEventTagProperties": {
+ "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
+ "id": "DefaultClickThroughEventTagProperties",
+ "properties": {
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
+ "format": "int64",
+ "type": "string"
+ },
+ "overrideInheritedEventTag": {
+ "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeliverySchedule": {
+ "description": "Delivery Schedule.",
+ "id": "DeliverySchedule",
+ "properties": {
+ "frequencyCap": {
+ "$ref": "FrequencyCap",
+ "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
+ },
+ "hardCutoff": {
+ "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.",
+ "type": "boolean"
+ },
+ "impressionRatio": {
+ "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "priority": {
+ "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
+ "enum": [
+ "AD_PRIORITY_01",
+ "AD_PRIORITY_02",
+ "AD_PRIORITY_03",
+ "AD_PRIORITY_04",
+ "AD_PRIORITY_05",
+ "AD_PRIORITY_06",
+ "AD_PRIORITY_07",
+ "AD_PRIORITY_08",
+ "AD_PRIORITY_09",
+ "AD_PRIORITY_10",
+ "AD_PRIORITY_11",
+ "AD_PRIORITY_12",
+ "AD_PRIORITY_13",
+ "AD_PRIORITY_14",
+ "AD_PRIORITY_15",
+ "AD_PRIORITY_16"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DfpSettings": {
+ "description": "Google Ad Manager Settings",
+ "id": "DfpSettings",
+ "properties": {
+ "dfpNetworkCode": {
+ "description": "Ad Manager network code for this directory site.",
+ "type": "string"
+ },
+ "dfpNetworkName": {
+ "description": "Ad Manager network name for this directory site.",
+ "type": "string"
+ },
+ "programmaticPlacementAccepted": {
+ "description": "Whether this directory site accepts programmatic placements.",
+ "type": "boolean"
+ },
+ "pubPaidPlacementAccepted": {
+ "description": "Whether this directory site accepts publisher-paid tags.",
+ "type": "boolean"
+ },
+ "publisherPortalOnly": {
+ "description": "Whether this directory site is available only via Publisher Portal.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "Represents a dimension.",
+ "id": "Dimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The dimension name, e.g. dfa:advertiser",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionFilter": {
+ "description": "Represents a dimension filter.",
+ "id": "DimensionFilter",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension to filter.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension to filter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValue": {
+ "description": "Represents a DimensionValue resource.",
+ "id": "DimensionValue",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID associated with the value if available.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "EXACT",
+ "BEGINS_WITH",
+ "CONTAINS",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueList": {
+ "description": "Represents the list of DimensionValue resources.",
+ "id": "DimensionValueList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The dimension values returned in this response.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueRequest": {
+ "description": "Represents a DimensionValuesRequest.",
+ "id": "DimensionValueRequest",
+ "properties": {
+ "dimensionName": {
+ "annotations": {
+ "required": [
+ "dfareporting.dimensionValues.query"
+ ]
+ },
+ "description": "The name of the dimension for which values should be requested.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The list of filters by which to filter values. The filters are ANDed.",
+ "items": {
+ "$ref": "DimensionFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySite": {
+ "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
+ "id": "DirectorySite",
+ "properties": {
+ "id": {
+ "description": "ID of this directory site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
+ },
+ "inpageTagFormats": {
+ "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ",
+ "items": {
+ "enum": [
+ "STANDARD",
+ "IFRAME_JAVASCRIPT_INPAGE",
+ "INTERNAL_REDIRECT_INPAGE",
+ "JAVASCRIPT_INPAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "interstitialTagFormats": {
+ "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "IFRAME_JAVASCRIPT_INTERSTITIAL",
+ "INTERNAL_REDIRECT_INTERSTITIAL",
+ "JAVASCRIPT_INTERSTITIAL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this directory site.",
+ "type": "string"
+ },
+ "settings": {
+ "$ref": "DirectorySiteSettings",
+ "description": "Directory site settings."
+ },
+ "url": {
+ "description": "URL of this directory site.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySiteSettings": {
+ "description": "Directory Site Settings",
+ "id": "DirectorySiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether this directory site has disabled active view creatives.",
+ "type": "boolean"
+ },
+ "dfpSettings": {
+ "$ref": "DfpSettings",
+ "description": "Directory site Ad Manager settings."
+ },
+ "instreamVideoPlacementAccepted": {
+ "description": "Whether this site accepts in-stream video ads.",
+ "type": "boolean"
+ },
+ "interstitialPlacementAccepted": {
+ "description": "Whether this site accepts interstitial ads.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySitesListResponse": {
+ "description": "Directory Site List Response",
+ "id": "DirectorySitesListResponse",
+ "properties": {
+ "directorySites": {
+ "description": "Directory site collection.",
+ "items": {
+ "$ref": "DirectorySite"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DisjunctiveMatchStatement": {
+ "description": "Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.",
+ "id": "DisjunctiveMatchStatement",
+ "properties": {
+ "eventFilters": {
+ "description": "The event filters contained within this disjunctive match statement.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKey": {
+ "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
+ "id": "DynamicTargetingKey",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKeysListResponse": {
+ "description": "Dynamic Targeting Key List Response",
+ "id": "DynamicTargetingKeysListResponse",
+ "properties": {
+ "dynamicTargetingKeys": {
+ "description": "Dynamic targeting key collection.",
+ "items": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EncryptionInfo": {
+ "description": "A description of how user IDs are encrypted.",
+ "id": "EncryptionInfo",
+ "properties": {
+ "encryptionEntityId": {
+ "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "encryptionEntityType": {
+ "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
+ "enum": [
+ "ENCRYPTION_ENTITY_TYPE_UNKNOWN",
+ "DCM_ACCOUNT",
+ "DCM_ADVERTISER",
+ "DBM_PARTNER",
+ "DBM_ADVERTISER",
+ "ADWORDS_CUSTOMER",
+ "DFP_NETWORK_CODE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "encryptionSource": {
+ "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
+ "enum": [
+ "ENCRYPTION_SCOPE_UNKNOWN",
+ "AD_SERVING",
+ "DATA_TRANSFER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventFilter": {
+ "description": "Represents a DfaReporting event filter.",
+ "id": "EventFilter",
+ "properties": {
+ "dimensionFilter": {
+ "$ref": "PathReportDimensionValue",
+ "description": "The dimension filter contained within this EventFilter."
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#eventFilter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTag": {
+ "description": "Contains properties of an event tag.",
+ "id": "EventTag",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "campaignId": {
+ "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "enabledByDefault": {
+ "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.",
+ "type": "boolean"
+ },
+ "excludeFromAdxRequests": {
+ "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this event tag. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "siteFilterType": {
+ "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
+ "enum": [
+ "WHITELIST",
+ "BLACKLIST"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sslCompliant": {
+ "description": "Whether this tag is SSL-compliant or not. This is a read-only field.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
+ "enum": [
+ "ENABLED",
+ "DISABLED"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.",
+ "type": "string"
+ },
+ "urlEscapeLevels": {
+ "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagOverride": {
+ "description": "Event tag override information.",
+ "id": "EventTagOverride",
+ "properties": {
+ "enabled": {
+ "description": "Whether this override is enabled.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag override. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagsListResponse": {
+ "description": "Event Tag List Response",
+ "id": "EventTagsListResponse",
+ "properties": {
+ "eventTags": {
+ "description": "Event tag collection.",
+ "items": {
+ "$ref": "EventTag"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "File": {
+ "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
+ "id": "File",
+ "properties": {
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename of the file.",
+ "type": "string"
+ },
+ "format": {
+ "description": "The output format of the report. Only available once the file is available.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of this report file.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "description": "The timestamp in milliseconds since epoch when this file was last modified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report this file was generated from.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the report file.",
+ "enum": [
+ "PROCESSING",
+ "REPORT_AVAILABLE",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "urls": {
+ "description": "The URLs where the completed report file can be downloaded.",
+ "properties": {
+ "apiUrl": {
+ "description": "The URL for downloading the report data through the API.",
+ "type": "string"
+ },
+ "browserUrl": {
+ "description": "The URL for downloading the report data through a browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "FileList": {
+ "description": "List of files for a report.",
+ "id": "FileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The files returned in this response.",
+ "items": {
+ "$ref": "File"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Flight": {
+ "description": "Flight",
+ "id": "Flight",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "rateOrCost": {
+ "description": "Rate or cost of this flight.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this flight.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesGenerateTagResponse": {
+ "description": "Floodlight Activity GenerateTag Response",
+ "id": "FloodlightActivitiesGenerateTagResponse",
+ "properties": {
+ "floodlightActivityTag": {
+ "description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
+ "type": "string"
+ },
+ "globalSiteTagGlobalSnippet": {
+ "description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesListResponse": {
+ "description": "Floodlight Activity List Response",
+ "id": "FloodlightActivitiesListResponse",
+ "properties": {
+ "floodlightActivities": {
+ "description": "Floodlight activity collection.",
+ "items": {
+ "$ref": "FloodlightActivity"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivity": {
+ "description": "Contains properties of a Floodlight activity.",
+ "id": "FloodlightActivity",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "attributionEnabled": {
+ "description": "Whether the activity is enabled for attribution.",
+ "type": "boolean"
+ },
+ "cacheBustingType": {
+ "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
+ "enum": [
+ "JAVASCRIPT",
+ "ACTIVE_SERVER_PAGE",
+ "JSP",
+ "PHP",
+ "COLD_FUSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "countingMethod": {
+ "description": "Counting method for conversions for this floodlight activity. This is a required field.",
+ "enum": [
+ "STANDARD_COUNTING",
+ "UNIQUE_COUNTING",
+ "SESSION_COUNTING",
+ "TRANSACTIONS_COUNTING",
+ "ITEMS_SOLD_COUNTING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "defaultTags": {
+ "description": "Dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityDynamicTag"
+ },
+ "type": "array"
+ },
+ "expectedUrl": {
+ "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
+ "type": "string"
+ },
+ "floodlightActivityGroupId": {
+ "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityGroupName": {
+ "description": "Name of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupTagString": {
+ "description": "Tag string of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupType": {
+ "description": "Type of the associated floodlight activity group. This is a read-only field.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "floodlightTagType": {
+ "description": "The type of Floodlight tag this activity will generate. This is a required field.",
+ "enum": [
+ "IFRAME",
+ "IMAGE",
+ "GLOBAL_SITE_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "General notes or implementation instructions for the tag.",
+ "type": "string"
+ },
+ "publisherTags": {
+ "description": "Publisher dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityPublisherDynamicTag"
+ },
+ "type": "array"
+ },
+ "secure": {
+ "description": "Whether this tag should use SSL.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this floodlight activity must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.",
+ "enum": [
+ "ACTIVE",
+ "ARCHIVED_AND_DISABLED",
+ "ARCHIVED",
+ "DISABLED_POLICY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormat": {
+ "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
+ "enum": [
+ "HTML",
+ "XHTML"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "userDefinedVariableTypes": {
+ "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
+ "items": {
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityDynamicTag": {
+ "description": "Dynamic Tag",
+ "id": "FloodlightActivityDynamicTag",
+ "properties": {
+ "id": {
+ "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this tag.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Tag code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroup": {
+ "description": "Contains properties of a Floodlight activity group.",
+ "id": "FloodlightActivityGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroupsListResponse": {
+ "description": "Floodlight Activity Group List Response",
+ "id": "FloodlightActivityGroupsListResponse",
+ "properties": {
+ "floodlightActivityGroups": {
+ "description": "Floodlight activity group collection.",
+ "items": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityPublisherDynamicTag": {
+ "description": "Publisher Dynamic Tag",
+ "id": "FloodlightActivityPublisherDynamicTag",
+ "properties": {
+ "clickThrough": {
+ "description": "Whether this tag is applicable only for click-throughs.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dynamicTag": {
+ "$ref": "FloodlightActivityDynamicTag",
+ "description": "Dynamic floodlight tag."
+ },
+ "siteId": {
+ "description": "Site ID of this dynamic tag.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "viewThrough": {
+ "description": "Whether this tag is applicable only for view-throughs.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfiguration": {
+ "description": "Contains properties of a Floodlight configuration.",
+ "id": "FloodlightConfiguration",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "analyticsDataSharingEnabled": {
+ "description": "Whether advertiser data is shared with Google Analytics.",
+ "type": "boolean"
+ },
+ "customViewabilityMetric": {
+ "$ref": "CustomViewabilityMetric",
+ "description": "Custom Viewability metric for the floodlight configuration."
+ },
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "firstDayOfWeek": {
+ "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
+ "enum": [
+ "MONDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "inAppAttributionTrackingEnabled": {
+ "description": "Whether in-app attribution tracking is enabled.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
+ "type": "string"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this floodlight configuration."
+ },
+ "naturalSearchConversionAttributionOption": {
+ "description": "Types of attribution options for natural search conversions.",
+ "enum": [
+ "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "omnitureSettings": {
+ "$ref": "OmnitureSettings",
+ "description": "Settings for Campaign Manager Omniture integration."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagSettings": {
+ "$ref": "TagSettings",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "thirdPartyAuthenticationTokens": {
+ "description": "List of third-party authentication tokens enabled for this configuration.",
+ "items": {
+ "$ref": "ThirdPartyAuthenticationToken"
+ },
+ "type": "array"
+ },
+ "userDefinedVariableConfigurations": {
+ "description": "List of user defined variables enabled for this configuration.",
+ "items": {
+ "$ref": "UserDefinedVariableConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfigurationsListResponse": {
+ "description": "Floodlight Configuration List Response",
+ "id": "FloodlightConfigurationsListResponse",
+ "properties": {
+ "floodlightConfigurations": {
+ "description": "Floodlight configuration collection.",
+ "items": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
+ "id": "FloodlightReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FrequencyCap": {
+ "description": "Frequency Cap.",
+ "id": "FrequencyCap",
+ "properties": {
+ "duration": {
+ "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "impressions": {
+ "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FsCommand": {
+ "description": "FsCommand.",
+ "id": "FsCommand",
+ "properties": {
+ "left": {
+ "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "positionOption": {
+ "description": "Position in the browser where the window will open.",
+ "enum": [
+ "CENTERED",
+ "DISTANCE_FROM_TOP_LEFT_CORNER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "top": {
+ "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowHeight": {
+ "description": "Height of the window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowWidth": {
+ "description": "Width of the window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GeoTargeting": {
+ "description": "Geographical Targeting.",
+ "id": "GeoTargeting",
+ "properties": {
+ "cities": {
+ "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "countries": {
+ "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "excludeCountries": {
+ "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.",
+ "type": "boolean"
+ },
+ "metros": {
+ "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ },
+ "postalCodes": {
+ "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ },
+ "regions": {
+ "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItem": {
+ "description": "Represents a buy from the Planning inventory store.",
+ "id": "InventoryItem",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adSlots": {
+ "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
+ "items": {
+ "$ref": "AdSlot"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "Content category ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedClickThroughRate": {
+ "description": "Estimated click-through rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedConversionRate": {
+ "description": "Estimated conversion rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inPlan": {
+ "description": "Whether this inventory item is in plan.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this inventory item."
+ },
+ "name": {
+ "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.",
+ "type": "string"
+ },
+ "negotiationChannelId": {
+ "description": "Negotiation channel ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "Order ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "Placement strategy ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricing": {
+ "$ref": "Pricing",
+ "description": "Pricing of this inventory item."
+ },
+ "projectId": {
+ "description": "Project ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rfpId": {
+ "description": "RFP ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "ID of the site this inventory item is associated with.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItemsListResponse": {
+ "description": "Inventory item List Response",
+ "id": "InventoryItemsListResponse",
+ "properties": {
+ "inventoryItems": {
+ "description": "Inventory item collection",
+ "items": {
+ "$ref": "InventoryItem"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "KeyValueTargetingExpression": {
+ "description": "Key Value Targeting Expression.",
+ "id": "KeyValueTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Keyword expression being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LandingPage": {
+ "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
+ "id": "LandingPage",
+ "properties": {
+ "advertiserId": {
+ "description": "Advertiser ID of this landing page. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Whether this landing page has been archived.",
+ "type": "boolean"
+ },
+ "deepLinks": {
+ "description": "Links that will direct the user to a mobile app, if installed.",
+ "items": {
+ "$ref": "DeepLink"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this landing page. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of this landing page. This is a required field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Language": {
+ "description": "Contains information about a language that can be targeted by ads.",
+ "id": "Language",
+ "properties": {
+ "id": {
+ "description": "Language ID of this language. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this language.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LanguageTargeting": {
+ "description": "Language Targeting.",
+ "id": "LanguageTargeting",
+ "properties": {
+ "languages": {
+ "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LanguagesListResponse": {
+ "description": "Language List Response",
+ "id": "LanguagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Language collection.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LastModifiedInfo": {
+ "description": "Modification timestamp.",
+ "id": "LastModifiedInfo",
+ "properties": {
+ "time": {
+ "description": "Timestamp of the last change in milliseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationClause": {
+ "description": "A group clause made up of list population terms representing constraints joined by ORs.",
+ "id": "ListPopulationClause",
+ "properties": {
+ "terms": {
+ "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationTerm"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationRule": {
+ "description": "Remarketing List Population Rule.",
+ "id": "ListPopulationRule",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityName": {
+ "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "listPopulationClauses": {
+ "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationClause"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationTerm": {
+ "description": "Remarketing List Population Rule Term.",
+ "id": "ListPopulationTerm",
+ "properties": {
+ "contains": {
+ "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
+ "type": "boolean"
+ },
+ "negation": {
+ "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "enum": [
+ "NUM_EQUALS",
+ "NUM_LESS_THAN",
+ "NUM_LESS_THAN_EQUAL",
+ "NUM_GREATER_THAN",
+ "NUM_GREATER_THAN_EQUAL",
+ "STRING_EQUALS",
+ "STRING_CONTAINS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
+ "enum": [
+ "CUSTOM_VARIABLE_TERM",
+ "LIST_MEMBERSHIP_TERM",
+ "REFERRER_TERM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ },
+ "variableFriendlyName": {
+ "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
+ "type": "string"
+ },
+ "variableName": {
+ "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListTargetingExpression": {
+ "description": "Remarketing List Targeting Expression.",
+ "id": "ListTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Expression describing which lists are being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LookbackConfiguration": {
+ "description": "Lookback configuration settings.",
+ "id": "LookbackConfiguration",
+ "properties": {
+ "clickDuration": {
+ "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "postImpressionActivitiesDuration": {
+ "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Metric": {
+ "description": "Represents a metric.",
+ "id": "Metric",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#metric.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The metric name, e.g. dfa:impressions",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metro": {
+ "description": "Contains information about a metro region that can be targeted by ads.",
+ "id": "Metro",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this metro region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this metro region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this metro region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dmaId": {
+ "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro code of this metro region. This is equivalent to dma_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this metro region.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetrosListResponse": {
+ "description": "Metro List Response",
+ "id": "MetrosListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
+ "type": "string"
+ },
+ "metros": {
+ "description": "Metro collection.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MobileApp": {
+ "description": "Contains information about a mobile app. Used as a landing page deep link.",
+ "id": "MobileApp",
+ "properties": {
+ "directory": {
+ "description": "Mobile app directory.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile app.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
+ "type": "string"
+ },
+ "publisherName": {
+ "description": "Publisher name.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this mobile app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileAppsListResponse": {
+ "description": "Mobile app List Response",
+ "id": "MobileAppsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
+ "type": "string"
+ },
+ "mobileApps": {
+ "description": "Mobile apps collection.",
+ "items": {
+ "$ref": "MobileApp"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarrier": {
+ "description": "Contains information about a mobile carrier that can be targeted by ads.",
+ "id": "MobileCarrier",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this mobile carrier belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this mobile carrier belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile carrier.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this mobile carrier.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarriersListResponse": {
+ "description": "Mobile Carrier List Response",
+ "id": "MobileCarriersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
+ "type": "string"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carrier collection.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ObaIcon": {
+ "description": "Online Behavioral Advertiser icon.",
+ "id": "ObaIcon",
+ "properties": {
+ "iconClickThroughUrl": {
+ "description": "URL to redirect to when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "iconClickTrackingUrl": {
+ "description": "URL to track click when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "iconViewTrackingUrl": {
+ "description": "URL to track view when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "program": {
+ "description": "Identifies the industry initiative that the icon supports. For example, AdChoices.",
+ "type": "string"
+ },
+ "resourceUrl": {
+ "description": "OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "OBA icon size."
+ },
+ "xPosition": {
+ "description": "OBA icon x coordinate position. Accepted values are left or right.",
+ "type": "string"
+ },
+ "yPosition": {
+ "description": "OBA icon y coordinate position. Accepted values are top or bottom.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ObjectFilter": {
+ "description": "Object Filter.",
+ "id": "ObjectFilter",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
+ "enum": [
+ "NONE",
+ "ASSIGNED",
+ "ALL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OffsetPosition": {
+ "description": "Offset Position.",
+ "id": "OffsetPosition",
+ "properties": {
+ "left": {
+ "description": "Offset distance from left side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "top": {
+ "description": "Offset distance from top side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OmnitureSettings": {
+ "description": "Omniture Integration Settings.",
+ "id": "OmnitureSettings",
+ "properties": {
+ "omnitureCostDataEnabled": {
+ "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
+ "type": "boolean"
+ },
+ "omnitureIntegrationEnabled": {
+ "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystem": {
+ "description": "Contains information about an operating system that can be targeted by ads.",
+ "id": "OperatingSystem",
+ "properties": {
+ "dartId": {
+ "description": "DART ID of this operating system. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "desktop": {
+ "description": "Whether this operating system is for desktop.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
+ "type": "string"
+ },
+ "mobile": {
+ "description": "Whether this operating system is for mobile.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Name of this operating system.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersion": {
+ "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
+ "id": "OperatingSystemVersion",
+ "properties": {
+ "id": {
+ "description": "ID of this operating system version.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version (leftmost number) of this operating system version.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version (number after the first dot) of this operating system version.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this operating system version.",
+ "type": "string"
+ },
+ "operatingSystem": {
+ "$ref": "OperatingSystem",
+ "description": "Operating system of this operating system version."
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersionsListResponse": {
+ "description": "Operating System Version List Response",
+ "id": "OperatingSystemVersionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system version collection.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemsListResponse": {
+ "description": "Operating System List Response",
+ "id": "OperatingSystemsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystems": {
+ "description": "Operating system collection.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OptimizationActivity": {
+ "description": "Creative optimization activity.",
+ "id": "OptimizationActivity",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID of this optimization activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
+ },
+ "weight": {
+ "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Order": {
+ "description": "Describes properties of a Planning order.",
+ "id": "Order",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approverUserProfileIds": {
+ "description": "IDs for users that have to approve documents created for this order.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "buyerInvoiceId": {
+ "description": "Buyer invoice ID associated with this order.",
+ "type": "string"
+ },
+ "buyerOrganizationName": {
+ "description": "Name of the buyer organization.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "Comments in this order.",
+ "type": "string"
+ },
+ "contacts": {
+ "description": "Contacts for this order.",
+ "items": {
+ "$ref": "OrderContact"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this order. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this order."
+ },
+ "name": {
+ "description": "Name of this order.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Notes of this order.",
+ "type": "string"
+ },
+ "planningTermId": {
+ "description": "ID of the terms and conditions template used in this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sellerOrderId": {
+ "description": "Seller order ID associated with this order.",
+ "type": "string"
+ },
+ "sellerOrganizationName": {
+ "description": "Name of the seller organization.",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Site IDs this order is associated with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "siteNames": {
+ "description": "Free-form site names this order is associated with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "termsAndConditions": {
+ "description": "Terms and conditions of this order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderContact": {
+ "description": "Contact of an order.",
+ "id": "OrderContact",
+ "properties": {
+ "contactInfo": {
+ "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "Name of this contact.",
+ "type": "string"
+ },
+ "contactTitle": {
+ "description": "Title of this contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Type of this contact.",
+ "enum": [
+ "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
+ "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
+ "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "signatureUserProfileId": {
+ "description": "ID of the user profile containing the signature that will be embedded into order documents.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocument": {
+ "description": "Contains properties of a Planning order document.",
+ "id": "OrderDocument",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "amendedOrderDocumentId": {
+ "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approvedByUserProfileIds": {
+ "description": "IDs of users who have approved this order document.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "cancelled": {
+ "description": "Whether this order document is cancelled.",
+ "type": "boolean"
+ },
+ "createdInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this order document."
+ },
+ "effectiveDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
+ "type": "string"
+ },
+ "lastSentRecipients": {
+ "description": "List of email addresses that received the last sent document.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "lastSentTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "ID of the order from which this order document is created.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "signed": {
+ "description": "Whether this order document has been signed.",
+ "type": "boolean"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this order document.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this order document",
+ "enum": [
+ "PLANNING_ORDER_TYPE_INSERTION_ORDER",
+ "PLANNING_ORDER_TYPE_CHANGE_ORDER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocumentsListResponse": {
+ "description": "Order document List Response",
+ "id": "OrderDocumentsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orderDocuments": {
+ "description": "Order document collection",
+ "items": {
+ "$ref": "OrderDocument"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersListResponse": {
+ "description": "Order List Response",
+ "id": "OrdersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orders": {
+ "description": "Order collection.",
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathFilter": {
+ "description": "Represents a DfaReporting path filter.",
+ "id": "PathFilter",
+ "properties": {
+ "eventFilters": {
+ "description": "Event filters in path report.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathFilter.",
+ "type": "string"
+ },
+ "pathMatchPosition": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "PATH_MATCH_POSITION_UNSPECIFIED",
+ "ANY",
+ "FIRST",
+ "LAST"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PathReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"PATH\".",
+ "id": "PathReportCompatibleFields",
+ "properties": {
+ "channelGroupings": {
+ "description": "Dimensions which are compatible to be selected in the \"channelGroupings\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pathFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"pathFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathReportDimensionValue": {
+ "description": "Represents a PathReportDimensionValue resource.",
+ "id": "PathReportDimensionValue",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "ids": {
+ "description": "The possible ID's associated with the value if available.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathReportDimensionValue.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "EXACT",
+ "BEGINS_WITH",
+ "CONTAINS",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "The possible values of the dimension.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathToConversionReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
+ "id": "PathToConversionReportCompatibleFields",
+ "properties": {
+ "conversionDimensions": {
+ "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "customFloodlightVariables": {
+ "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "perInteractionDimensions": {
+ "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Placement": {
+ "description": "Contains properties of a placement.",
+ "id": "Placement",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement. This field is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "comment": {
+ "description": "Comments for this placement.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this placement. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement. This is a read-only field."
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this placement."
+ },
+ "name": {
+ "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.",
+ "type": "string"
+ },
+ "paymentApproved": {
+ "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
+ "type": "boolean"
+ },
+ "paymentSource": {
+ "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementGroupId": {
+ "description": "ID of this placement's group, if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementGroupIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
+ },
+ "primary": {
+ "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
+ "type": "boolean"
+ },
+ "publisherUpdateInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the last publisher update. This is a read-only field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
+ },
+ "sslRequired": {
+ "description": "Whether creatives assigned to this placement must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Third-party placement status.",
+ "enum": [
+ "PENDING_REVIEW",
+ "PAYMENT_ACCEPTED",
+ "PAYMENT_REJECTED",
+ "ACKNOWLEDGE_REJECTION",
+ "ACKNOWLEDGE_ACCEPTANCE",
+ "DRAFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
+ "items": {
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Tag settings for this placement."
+ },
+ "videoActiveViewOptOut": {
+ "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
+ "type": "boolean"
+ },
+ "videoSettings": {
+ "$ref": "VideoSettings",
+ "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
+ },
+ "vpaidAdapterChoice": {
+ "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementAssignment": {
+ "description": "Placement Assignment.",
+ "id": "PlacementAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "placementId": {
+ "description": "ID of the placement to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
+ },
+ "sslRequired": {
+ "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroup": {
+ "description": "Contains properties of a package or roadblock.",
+ "id": "PlacementGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement group is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement group. This field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "childPlacementIds": {
+ "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "comment": {
+ "description": "Comments for this placement group.",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement group. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement group. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement group. This field is required on insertion."
+ },
+ "primaryPlacementId": {
+ "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
+ "format": "int64",
+ "type": "string"
+ },
+ "primaryPlacementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroupsListResponse": {
+ "description": "Placement Group List Response",
+ "id": "PlacementGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placementGroups": {
+ "description": "Placement group collection.",
+ "items": {
+ "$ref": "PlacementGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategiesListResponse": {
+ "description": "Placement Strategy List Response",
+ "id": "PlacementStrategiesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placementStrategies": {
+ "description": "Placement strategy collection.",
+ "items": {
+ "$ref": "PlacementStrategy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategy": {
+ "description": "Contains properties of a placement strategy.",
+ "id": "PlacementStrategy",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementTag": {
+ "description": "Placement Tag",
+ "id": "PlacementTag",
+ "properties": {
+ "placementId": {
+ "description": "Placement ID",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagDatas": {
+ "description": "Tags generated for this placement.",
+ "items": {
+ "$ref": "TagData"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsGenerateTagsResponse": {
+ "description": "Placement GenerateTags Response",
+ "id": "PlacementsGenerateTagsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
+ "type": "string"
+ },
+ "placementTags": {
+ "description": "Set of generated tags for the specified placements.",
+ "items": {
+ "$ref": "PlacementTag"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsListResponse": {
+ "description": "Placement List Response",
+ "id": "PlacementsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placements": {
+ "description": "Placement collection.",
+ "items": {
+ "$ref": "Placement"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformType": {
+ "description": "Contains information about a platform type that can be targeted by ads.",
+ "id": "PlatformType",
+ "properties": {
+ "id": {
+ "description": "ID of this platform type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this platform type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformTypesListResponse": {
+ "description": "Platform Type List Response",
+ "id": "PlatformTypesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
+ "type": "string"
+ },
+ "platformTypes": {
+ "description": "Platform type collection.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PopupWindowProperties": {
+ "description": "Popup Window Properties.",
+ "id": "PopupWindowProperties",
+ "properties": {
+ "dimension": {
+ "$ref": "Size",
+ "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
+ },
+ "positionType": {
+ "description": "Popup window position either centered or at specific coordinate.",
+ "enum": [
+ "CENTER",
+ "COORDINATES"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "showAddressBar": {
+ "description": "Whether to display the browser address bar.",
+ "type": "boolean"
+ },
+ "showMenuBar": {
+ "description": "Whether to display the browser menu bar.",
+ "type": "boolean"
+ },
+ "showScrollBar": {
+ "description": "Whether to display the browser scroll bar.",
+ "type": "boolean"
+ },
+ "showStatusBar": {
+ "description": "Whether to display the browser status bar.",
+ "type": "boolean"
+ },
+ "showToolBar": {
+ "description": "Whether to display the browser tool bar.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Title of popup window.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCode": {
+ "description": "Contains information about a postal code that can be targeted by ads.",
+ "id": "PostalCode",
+ "properties": {
+ "code": {
+ "description": "Postal code. This is equivalent to the id field.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the country to which this postal code belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this postal code belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this postal code.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodesListResponse": {
+ "description": "Postal Code List Response",
+ "id": "PostalCodesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
+ "type": "string"
},
- "PostalCodesListResponse": {
- "description": "Postal Code List Response",
- "id": "PostalCodesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
- "type": "string"
- },
- "postalCodes": {
- "description": "Postal code collection.",
- "items": {
- "$ref": "PostalCode"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Pricing": {
- "description": "Pricing Information",
- "id": "Pricing",
- "properties": {
- "capCostType": {
- "description": "Cap cost type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "flights": {
- "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
- "items": {
- "$ref": "Flight"
- },
- "type": "array"
- },
- "groupType": {
- "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
- "enum": [
- "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
- "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "pricingType": {
- "description": "Pricing type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
- "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PricingSchedule": {
- "description": "Pricing Schedule",
- "id": "PricingSchedule",
- "properties": {
- "capCostOption": {
- "description": "Placement cap cost option.",
- "enum": [
- "CAP_COST_NONE",
- "CAP_COST_MONTHLY",
- "CAP_COST_CUMULATIVE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "flighted": {
- "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.",
- "type": "boolean"
- },
- "floodlightActivityId": {
- "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
- "format": "int64",
- "type": "string"
- },
- "pricingPeriods": {
- "description": "Pricing periods for this placement.",
- "items": {
- "$ref": "PricingSchedulePricingPeriod"
- },
- "type": "array"
- },
- "pricingType": {
- "description": "Placement pricing type. This field is required on insertion.",
- "enum": [
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_CPM_ACTIVEVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "testingStartDate": {
- "format": "date",
- "type": "string"
- }
- },
- "type": "object"
+ "postalCodes": {
+ "description": "Postal code collection.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Pricing": {
+ "description": "Pricing Information",
+ "id": "Pricing",
+ "properties": {
+ "capCostType": {
+ "description": "Cap cost type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flights": {
+ "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
+ "items": {
+ "$ref": "Flight"
+ },
+ "type": "array"
+ },
+ "groupType": {
+ "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
+ "enum": [
+ "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
+ "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "pricingType": {
+ "description": "Pricing type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedule": {
+ "description": "Pricing Schedule",
+ "id": "PricingSchedule",
+ "properties": {
+ "capCostOption": {
+ "description": "Placement cap cost option.",
+ "enum": [
+ "CAP_COST_NONE",
+ "CAP_COST_MONTHLY",
+ "CAP_COST_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flighted": {
+ "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.",
+ "type": "boolean"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingPeriods": {
+ "description": "Pricing periods for this placement.",
+ "items": {
+ "$ref": "PricingSchedulePricingPeriod"
+ },
+ "type": "array"
+ },
+ "pricingType": {
+ "description": "Placement pricing type. This field is required on insertion.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "testingStartDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedulePricingPeriod": {
+ "description": "Pricing Period",
+ "id": "PricingSchedulePricingPeriod",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "pricingComment": {
+ "description": "Comments for this pricing period.",
+ "type": "string"
+ },
+ "rateOrCostNanos": {
+ "description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Project": {
+ "description": "Contains properties of a Planning project.",
+ "id": "Project",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "audienceAgeGroup": {
+ "description": "Audience age group of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_AGE_18_24",
+ "PLANNING_AUDIENCE_AGE_25_34",
+ "PLANNING_AUDIENCE_AGE_35_44",
+ "PLANNING_AUDIENCE_AGE_45_54",
+ "PLANNING_AUDIENCE_AGE_55_64",
+ "PLANNING_AUDIENCE_AGE_65_OR_MORE",
+ "PLANNING_AUDIENCE_AGE_UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "audienceGender": {
+ "description": "Audience gender of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_GENDER_MALE",
+ "PLANNING_AUDIENCE_GENDER_FEMALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "budget": {
+ "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientBillingCode": {
+ "description": "Client billing code of this project.",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the project client.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this project. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this project."
+ },
+ "name": {
+ "description": "Name of this project.",
+ "type": "string"
+ },
+ "overview": {
+ "description": "Overview of this project.",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetClicks": {
+ "description": "Number of clicks that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetConversions": {
+ "description": "Number of conversions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpaNanos": {
+ "description": "CPA that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpcNanos": {
+ "description": "CPC that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmActiveViewNanos": {
+ "description": "vCPM from Active View that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmNanos": {
+ "description": "CPM that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetImpressions": {
+ "description": "Number of impressions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectsListResponse": {
+ "description": "Project List Response",
+ "id": "ProjectsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "PricingSchedulePricingPeriod": {
- "description": "Pricing Period",
- "id": "PricingSchedulePricingPeriod",
- "properties": {
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "pricingComment": {
- "description": "Comments for this pricing period.",
- "type": "string"
- },
- "rateOrCostNanos": {
- "description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "units": {
- "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "projects": {
+ "description": "Project collection.",
+ "items": {
+ "$ref": "Project"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
+ "id": "ReachReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "reachByFrequencyMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Recipient": {
+ "description": "Represents a recipient.",
+ "id": "Recipient",
+ "properties": {
+ "deliveryType": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The delivery type for the recipient.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The email address of the recipient.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#recipient.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Region": {
+ "description": "Contains information about a region that can be targeted by ads.",
+ "id": "Region",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this region.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionsListResponse": {
+ "description": "Region List Response",
+ "id": "RegionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
+ "type": "string"
},
- "Project": {
- "description": "Contains properties of a Planning project.",
- "id": "Project",
- "properties": {
- "accountId": {
- "description": "Account ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "audienceAgeGroup": {
- "description": "Audience age group of this project.",
- "enum": [
- "PLANNING_AUDIENCE_AGE_18_24",
- "PLANNING_AUDIENCE_AGE_25_34",
- "PLANNING_AUDIENCE_AGE_35_44",
- "PLANNING_AUDIENCE_AGE_45_54",
- "PLANNING_AUDIENCE_AGE_55_64",
- "PLANNING_AUDIENCE_AGE_65_OR_MORE",
- "PLANNING_AUDIENCE_AGE_UNKNOWN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "audienceGender": {
- "description": "Audience gender of this project.",
- "enum": [
- "PLANNING_AUDIENCE_GENDER_MALE",
- "PLANNING_AUDIENCE_GENDER_FEMALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "budget": {
- "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
- "format": "int64",
- "type": "string"
- },
- "clientBillingCode": {
- "description": "Client billing code of this project.",
- "type": "string"
- },
- "clientName": {
- "description": "Name of the project client.",
- "type": "string"
- },
- "endDate": {
- "format": "date",
- "type": "string"
- },
- "id": {
- "description": "ID of this project. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
- "type": "string"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this project."
- },
- "name": {
- "description": "Name of this project.",
- "type": "string"
- },
- "overview": {
- "description": "Overview of this project.",
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this project.",
- "format": "int64",
- "type": "string"
- },
- "targetClicks": {
- "description": "Number of clicks that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetConversions": {
- "description": "Number of conversions that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpaNanos": {
- "description": "CPA that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpcNanos": {
- "description": "CPC that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpmActiveViewNanos": {
- "description": "vCPM from Active View that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetCpmNanos": {
- "description": "CPM that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- },
- "targetImpressions": {
- "description": "Number of impressions that the advertiser is targeting.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "regions": {
+ "description": "Region collection.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingList": {
+ "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
+ "id": "RemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "description": {
+ "description": "Remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listPopulationRule": {
+ "$ref": "ListPopulationRule",
+ "description": "Rule used to populate the remarketing list with users."
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListShare": {
+ "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
+ "id": "RemarketingListShare",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sharedAccountIds": {
+ "description": "Accounts that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
},
- "ProjectsListResponse": {
- "description": "Project List Response",
- "id": "ProjectsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "projects": {
- "description": "Project collection.",
- "items": {
- "$ref": "Project"
- },
- "type": "array"
- }
+ "sharedAdvertiserIds": {
+ "description": "Advertisers that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListsListResponse": {
+ "description": "Remarketing list response",
+ "id": "RemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "remarketingLists": {
+ "description": "Remarketing list collection.",
+ "items": {
+ "$ref": "RemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "Represents a Report resource.",
+ "id": "Report",
+ "properties": {
+ "accountId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The account ID to which this report belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "criteria": {
+ "description": "The report criteria for a report of type \"STANDARD\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
},
- "type": "object"
- },
- "ReachReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "id": "ReachReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "pivotedActivityMetrics": {
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "reachByFrequencyMetrics": {
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
},
- "type": "object"
- },
- "Recipient": {
- "description": "Represents a recipient.",
- "id": "Recipient",
- "properties": {
- "deliveryType": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The delivery type for the recipient.",
- "enum": [
- "LINK",
- "ATTACHMENT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "email": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The email address of the recipient.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which this report should be run."
},
- "type": "object"
- },
- "Region": {
- "description": "Contains information about a region that can be targeted by ads.",
- "id": "Region",
- "properties": {
- "countryCode": {
- "description": "Country code of the country to which this region belongs.",
- "type": "string"
- },
- "countryDartId": {
- "description": "DART ID of the country to which this region belongs.",
- "format": "int64",
- "type": "string"
- },
- "dartId": {
- "description": "DART ID of this region.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this region.",
- "type": "string"
- },
- "regionCode": {
- "description": "Region code.",
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "RegionsListResponse": {
- "description": "Region List Response",
- "id": "RegionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
- "type": "string"
- },
- "regions": {
- "description": "Region collection.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
+ "dimensions": {
+ "description": "The list of standard dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "RemarketingList": {
- "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
- "id": "RemarketingList",
- "properties": {
- "accountId": {
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this remarketing list is active.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "description": {
- "description": "Remarketing list description.",
- "type": "string"
- },
- "id": {
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
- "type": "string"
- },
- "lifeSpan": {
- "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.",
- "format": "int64",
- "type": "string"
- },
- "listPopulationRule": {
- "$ref": "ListPopulationRule",
- "description": "Rule used to populate the remarketing list with users."
- },
- "listSize": {
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "listSource": {
- "description": "Product from which this remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_OTHER",
- "REMARKETING_LIST_SOURCE_ADX",
- "REMARKETING_LIST_SOURCE_DFP",
- "REMARKETING_LIST_SOURCE_XFP",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_YOUTUBE",
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_GPLUS",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "crossDimensionReachCriteria": {
+ "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
+ "properties": {
+ "breakdown": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "RemarketingListShare": {
- "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
- "id": "RemarketingListShare",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
- "type": "string"
- },
- "remarketingListId": {
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "sharedAccountIds": {
- "description": "Accounts that the remarketing list is shared with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "sharedAdvertiserIds": {
- "description": "Advertisers that the remarketing list is shared with.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "RemarketingListsListResponse": {
- "description": "Remarketing list response",
- "id": "RemarketingListsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "remarketingLists": {
- "description": "Remarketing list collection.",
- "items": {
- "$ref": "RemarketingList"
- },
- "type": "array"
- }
+ "dimension": {
+ "description": "The dimension option.",
+ "enum": [
+ "ADVERTISER",
+ "CAMPAIGN",
+ "SITE_BY_ADVERTISER",
+ "SITE_BY_CAMPAIGN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
- },
- "Report": {
- "description": "Represents a Report resource.",
- "id": "Report",
- "properties": {
- "accountId": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "type": "string"
- },
- "criteria": {
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "crossDimensionReachCriteria": {
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "description": "The dimension option.",
- "enum": [
- "ADVERTISER",
- "CAMPAIGN",
- "SITE_BY_ADVERTISER",
- "SITE_BY_CAMPAIGN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "overlapMetricNames": {
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pivoted": {
- "description": "Whether the report is pivoted or not. Defaults to true.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "delivery": {
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "description": "Whether the report should be emailed to the report owner.",
- "type": "boolean"
- },
- "emailOwnerDeliveryType": {
- "description": "The type of delivery for the owner to receive, if enabled.",
- "enum": [
- "LINK",
- "ATTACHMENT"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "message": {
- "description": "The message to be sent with each email.",
- "type": "string"
- },
- "recipients": {
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "fileName": {
- "description": "The filename used when generating report files for this report.",
- "type": "string"
- },
- "floodlightCriteria": {
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reportProperties": {
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "description": "Include conversions that have no cookie, but do have an exposure path.",
- "type": "boolean"
- },
- "includeUnattributedCookieConversions": {
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
- "type": "boolean"
- },
- "includeUnattributedIPConversions": {
- "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
- "type": "boolean"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "format": {
- "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "type": "string"
- },
- "lastModifiedTime": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "type": "string"
- },
- "name": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The name of the report.",
- "type": "string"
- },
- "ownerProfileId": {
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- },
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "type": "string"
- },
- "pathAttributionCriteria": {
- "description": "The report criteria for a report of type \"PATH_ATTRIBUTION\".",
- "properties": {
- "activityFilters": {
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "customChannelGrouping": {
- "$ref": "ChannelGrouping",
- "description": "Channel Grouping."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pathFilters": {
- "description": "Path Filters.",
- "items": {
- "$ref": "PathFilter"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "pathCriteria": {
- "description": "The report criteria for a report of type \"PATH\".",
- "properties": {
- "activityFilters": {
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "customChannelGrouping": {
- "$ref": "ChannelGrouping",
- "description": "Channel Grouping."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pathFilters": {
- "description": "Path Filters.",
- "items": {
- "$ref": "PathFilter"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "pathToConversionCriteria": {
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "conversionDimensions": {
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "customFloodlightVariables": {
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "customRichMediaEvents": {
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "perInteractionDimensions": {
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "reportProperties": {
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "impressionsLookbackWindow": {
- "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "includeAttributedIPConversions": {
- "description": "Deprecated: has no effect.",
- "type": "boolean"
- },
- "includeUnattributedCookieConversions": {
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
- "type": "boolean"
- },
- "includeUnattributedIPConversions": {
- "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
- "type": "boolean"
- },
- "maximumClickInteractions": {
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32",
- "type": "integer"
- },
- "maximumImpressionInteractions": {
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32",
- "type": "integer"
- },
- "maximumInteractionGap": {
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32",
- "type": "integer"
- },
- "pivotOnInteractionPath": {
- "description": "Enable pivoting on interaction path.",
- "type": "boolean"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "reachCriteria": {
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- },
- "type": "array"
- },
- "enableAllDimensionCombinations": {
- "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
- "type": "boolean"
- },
- "metricNames": {
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reachByFrequencyMetricNames": {
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "schedule": {
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "type": "boolean"
- },
- "every": {
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32",
- "type": "integer"
- },
- "expirationDate": {
- "format": "date",
- "type": "string"
- },
- "repeats": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ",
- "type": "string"
- },
- "repeatsOnWeekDays": {
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "enum": [
- "SUNDAY",
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "runsOnDayOfMonth": {
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
- "enum": [
- "DAY_OF_MONTH",
- "WEEK_OF_MONTH"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "startDate": {
- "format": "date",
- "type": "string"
- }
- },
- "type": "object"
- },
- "subAccountId": {
- "description": "The subaccount ID to which this report belongs if applicable.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- },
- "description": "The type of the report.",
- "enum": [
- "STANDARD",
- "REACH",
- "PATH_TO_CONVERSION",
- "CROSS_DIMENSION_REACH",
- "FLOODLIGHT",
- "PATH",
- "PATH_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ReportCompatibleFields": {
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "id": "ReportCompatibleFields",
- "properties": {
- "dimensionFilters": {
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "type": "string"
- },
- "metrics": {
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "pivotedActivityMetrics": {
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ReportList": {
- "description": "Represents the list of reports.",
- "id": "ReportList",
- "properties": {
- "etag": {
- "description": "The eTag of this response for caching purposes.",
- "type": "string"
- },
- "items": {
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
- "type": "string"
- }
+ "overlapMetricNames": {
+ "description": "The list of names of overlap metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "ReportsConfiguration": {
- "description": "Reporting Configuration",
- "id": "ReportsConfiguration",
- "properties": {
- "exposureToConversionEnabled": {
- "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
- "type": "boolean"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Default lookback windows for new advertisers in this account."
- },
- "reportGenerationTimeZoneId": {
- "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
- "format": "int64",
- "type": "string"
- }
+ "pivoted": {
+ "description": "Whether the report is pivoted or not. Defaults to true.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "delivery": {
+ "description": "The report's email delivery settings.",
+ "properties": {
+ "emailOwner": {
+ "description": "Whether the report should be emailed to the report owner.",
+ "type": "boolean"
},
- "type": "object"
- },
- "RichMediaExitOverride": {
- "description": "Rich Media Exit Override.",
- "id": "RichMediaExitOverride",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
- },
- "enabled": {
- "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.",
- "type": "boolean"
- },
- "exitId": {
- "description": "ID for the override to refer to a specific exit in the creative.",
- "format": "int64",
- "type": "string"
- }
+ "emailOwnerDeliveryType": {
+ "description": "The type of delivery for the owner to receive, if enabled.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
- },
- "Rule": {
- "description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
- "id": "Rule",
- "properties": {
- "assetId": {
- "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "A user-friendly name for this rule. This is a required field.",
- "type": "string"
- },
- "targetingTemplateId": {
- "description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
- "format": "int64",
- "type": "string"
- }
+ "message": {
+ "description": "The message to be sent with each email.",
+ "type": "string"
},
- "type": "object"
- },
- "Site": {
- "description": "Contains properties of a site.",
- "id": "Site",
- "properties": {
- "accountId": {
- "description": "Account ID of this site. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "approved": {
- "description": "Whether this site is approved.",
- "type": "boolean"
- },
- "directorySiteId": {
- "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
- "format": "int64",
- "type": "string"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "id": {
- "description": "ID of this site. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
- },
- "keyName": {
- "description": "Key name of this site. This is a read-only, auto-generated field.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.",
- "type": "string"
- },
- "siteContacts": {
- "description": "Site contacts.",
- "items": {
- "$ref": "SiteContact"
- },
- "type": "array"
- },
- "siteSettings": {
- "$ref": "SiteSettings",
- "description": "Site-wide settings."
- },
- "subaccountId": {
- "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "videoSettings": {
- "$ref": "SiteVideoSettings",
- "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
- }
+ "recipients": {
+ "description": "The list of recipients to which to email the report.",
+ "items": {
+ "$ref": "Recipient"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename used when generating report files for this report.",
+ "type": "string"
+ },
+ "floodlightCriteria": {
+ "description": "The report criteria for a report of type \"FLOODLIGHT\".",
+ "properties": {
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteCompanionSetting": {
- "description": "Companion Settings",
- "id": "SiteCompanionSetting",
- "properties": {
- "companionsDisabled": {
- "description": "Whether companions are disabled for this site template.",
- "type": "boolean"
- },
- "enabledSizes": {
- "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- },
- "imageOnly": {
- "description": "Whether to serve only static images as companions.",
- "type": "boolean"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "SiteContact": {
- "description": "Site Contact",
- "id": "SiteContact",
- "properties": {
- "address": {
- "description": "Address of this site contact.",
- "type": "string"
- },
- "contactType": {
- "description": "Site contact type.",
- "enum": [
- "SALES_PERSON",
- "TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "email": {
- "description": "Email address of this site contact. This is a required field.",
- "type": "string"
- },
- "firstName": {
- "description": "First name of this site contact.",
- "type": "string"
- },
- "id": {
- "description": "ID of this site contact. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "lastName": {
- "description": "Last name of this site contact.",
- "type": "string"
- },
- "phone": {
- "description": "Primary phone number of this site contact.",
- "type": "string"
- },
- "title": {
- "description": "Title or designation of this site contact.",
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteSettings": {
- "description": "Site Settings",
- "id": "SiteSettings",
- "properties": {
- "activeViewOptOut": {
- "description": "Whether active view creatives are disabled for this site.",
- "type": "boolean"
- },
- "adBlockingOptOut": {
- "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.",
- "type": "boolean"
- },
- "disableNewCookie": {
- "description": "Whether new cookies are disabled for this site.",
- "type": "boolean"
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "videoActiveViewOptOutTemplate": {
- "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
- "type": "boolean"
- },
- "vpaidAdapterChoiceTemplate": {
- "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
- "enum": [
- "DEFAULT",
- "FLASH",
- "HTML5",
- "BOTH"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteSkippableSetting": {
- "description": "Skippable Settings",
- "id": "SiteSkippableSetting",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true."
- },
- "skippable": {
- "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.",
- "type": "boolean"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "SiteTranscodeSetting": {
- "description": "Transcode Settings",
- "id": "SiteTranscodeSetting",
- "properties": {
- "enabledVideoFormats": {
- "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SiteVideoSettings": {
- "description": "Video Settings",
- "id": "SiteVideoSettings",
- "properties": {
- "companionSettings": {
- "$ref": "SiteCompanionSetting",
- "description": "Settings for the companion creatives of video creatives served to this site."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".",
- "type": "string"
- },
- "obaEnabled": {
- "description": "Whether OBA icons are enabled for this placement.",
- "type": "boolean"
- },
- "obaSettings": {
- "$ref": "ObaIcon",
- "description": "Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site."
- },
- "orientation": {
- "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
- "enum": [
- "ANY",
- "LANDSCAPE",
- "PORTRAIT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "skippableSettings": {
- "$ref": "SiteSkippableSetting",
- "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site."
- },
- "transcodeSettings": {
- "$ref": "SiteTranscodeSetting",
- "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site."
- }
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "includeAttributedIPConversions": {
+ "description": "Include conversions that have no cookie, but do have an exposure path.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "format": {
+ "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The unique ID identifying this report resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#report.",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The name of the report.",
+ "type": "string"
+ },
+ "ownerProfileId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The user profile id of the owner of this report.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pathAttributionCriteria": {
+ "description": "The report criteria for a report of type \"PATH_ATTRIBUTION\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SitesListResponse": {
- "description": "Site List Response",
- "id": "SitesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "sites": {
- "description": "Site collection.",
- "items": {
- "$ref": "Site"
- },
- "type": "array"
- }
+ "customChannelGrouping": {
+ "$ref": "ChannelGrouping",
+ "description": "Channel Grouping."
},
- "type": "object"
- },
- "Size": {
- "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
- "id": "Size",
- "properties": {
- "height": {
- "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "iab": {
- "description": "IAB standard size. This is a read-only, auto-generated field.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this size. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
- "type": "string"
- },
- "width": {
- "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
- "format": "int32",
- "type": "integer"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "SizesListResponse": {
- "description": "Size List Response",
- "id": "SizesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
- "type": "string"
- },
- "sizes": {
- "description": "Size collection.",
- "items": {
- "$ref": "Size"
- },
- "type": "array"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SkippableSetting": {
- "description": "Skippable Settings",
- "id": "SkippableSetting",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
- "type": "string"
- },
- "progressOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true."
- },
- "skipOffset": {
- "$ref": "VideoOffset",
- "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
- },
- "skippable": {
- "description": "Whether the user can skip creatives served to this placement.",
- "type": "boolean"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "SortedDimension": {
- "description": "Represents a sorted dimension.",
- "id": "SortedDimension",
- "properties": {
- "kind": {
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "type": "string"
- },
- "name": {
- "description": "The name of the dimension.",
- "type": "string"
- },
- "sortOrder": {
- "description": "An optional sort order for the dimension column.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "Subaccount": {
- "description": "Contains properties of a Campaign Manager subaccount.",
- "id": "Subaccount",
- "properties": {
- "accountId": {
- "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "availablePermissionIds": {
- "description": "IDs of the available user role permissions for this subaccount.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of this subaccount. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.",
- "type": "string"
- }
+ "pathFilters": {
+ "description": "Path Filters.",
+ "items": {
+ "$ref": "PathFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "pathCriteria": {
+ "description": "The report criteria for a report of type \"PATH\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "SubaccountsListResponse": {
- "description": "Subaccount List Response",
- "id": "SubaccountsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "subaccounts": {
- "description": "Subaccount collection.",
- "items": {
- "$ref": "Subaccount"
- },
- "type": "array"
- }
+ "customChannelGrouping": {
+ "$ref": "ChannelGrouping",
+ "description": "Channel Grouping."
},
- "type": "object"
- },
- "TagData": {
- "description": "Placement Tag Data",
- "id": "TagData",
- "properties": {
- "adId": {
- "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
- "format": "int64",
- "type": "string"
- },
- "clickTag": {
- "description": "Tag string to record a click.",
- "type": "string"
- },
- "creativeId": {
- "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
- "format": "int64",
- "type": "string"
- },
- "format": {
- "description": "TagData tag format of this tag.",
- "enum": [
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "impressionTag": {
- "description": "Tag string for serving an ad.",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "TagSetting": {
- "description": "Tag Settings",
- "id": "TagSetting",
- "properties": {
- "additionalKeyValues": {
- "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.",
- "type": "string"
- },
- "includeClickThroughUrls": {
- "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.",
- "type": "boolean"
- },
- "includeClickTracking": {
- "description": "Whether click-tracking string should be included in the tags.",
- "type": "boolean"
- },
- "keywordOption": {
- "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
- "enum": [
- "PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
- "IGNORE",
- "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TagSettings": {
- "description": "Dynamic and Image Tag Settings.",
- "id": "TagSettings",
- "properties": {
- "dynamicTagEnabled": {
- "description": "Whether dynamic floodlight tags are enabled.",
- "type": "boolean"
- },
- "imageTagEnabled": {
- "description": "Whether image tags are enabled.",
- "type": "boolean"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "TargetWindow": {
- "description": "Target Window.",
- "id": "TargetWindow",
- "properties": {
- "customHtml": {
- "description": "User-entered value.",
- "type": "string"
- },
- "targetWindowOption": {
- "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
- "enum": [
- "NEW_WINDOW",
- "CURRENT_WINDOW",
- "CUSTOM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetableRemarketingList": {
- "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
- "id": "TargetableRemarketingList",
- "properties": {
- "accountId": {
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- },
- "active": {
- "description": "Whether this targetable remarketing list is active.",
- "type": "boolean"
- },
- "advertiserId": {
- "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser."
- },
- "description": {
- "description": "Targetable remarketing list description.",
- "type": "string"
- },
- "id": {
- "description": "Targetable remarketing list ID.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
- "type": "string"
- },
- "lifeSpan": {
- "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
- "format": "int64",
- "type": "string"
- },
- "listSize": {
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64",
- "type": "string"
- },
- "listSource": {
- "description": "Product from which this targetable remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_OTHER",
- "REMARKETING_LIST_SOURCE_ADX",
- "REMARKETING_LIST_SOURCE_DFP",
- "REMARKETING_LIST_SOURCE_XFP",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_YOUTUBE",
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_GPLUS",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_PLAY_STORE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64",
- "type": "string"
- }
+ "pathFilters": {
+ "description": "Path Filters.",
+ "items": {
+ "$ref": "PathFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "pathToConversionCriteria": {
+ "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetableRemarketingListsListResponse": {
- "description": "Targetable remarketing list response",
- "id": "TargetableRemarketingListsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "targetableRemarketingLists": {
- "description": "Targetable remarketing list collection.",
- "items": {
- "$ref": "TargetableRemarketingList"
- },
- "type": "array"
- }
+ "conversionDimensions": {
+ "description": "The list of conversion dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetingTemplate": {
- "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.",
- "id": "TargetingTemplate",
- "properties": {
- "accountId": {
- "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "advertiserId": {
- "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting criteria."
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting criteria."
- },
- "id": {
- "description": "ID of this targeting template. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting criteria."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
- "type": "string"
- },
- "languageTargeting": {
- "$ref": "LanguageTargeting",
- "description": "Language targeting criteria."
- },
- "listTargetingExpression": {
- "$ref": "ListTargetingExpression",
- "description": "Remarketing list targeting criteria."
- },
- "name": {
- "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.",
- "type": "string"
- },
- "subaccountId": {
- "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
- "format": "int64",
- "type": "string"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting criteria."
- }
+ "customFloodlightVariables": {
+ "description": "The list of custom floodlight variables the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TargetingTemplatesListResponse": {
- "description": "Targeting Template List Response",
- "id": "TargetingTemplatesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "targetingTemplates": {
- "description": "Targeting template collection.",
- "items": {
- "$ref": "TargetingTemplate"
- },
- "type": "array"
- }
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TechnologyTargeting": {
- "description": "Technology Targeting.",
- "id": "TechnologyTargeting",
- "properties": {
- "browsers": {
- "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Browser"
- },
- "type": "array"
- },
- "connectionTypes": {
- "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "ConnectionType"
- },
- "type": "array"
- },
- "mobileCarriers": {
- "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
- "items": {
- "$ref": "MobileCarrier"
- },
- "type": "array"
- },
- "operatingSystemVersions": {
- "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
- "items": {
- "$ref": "OperatingSystemVersion"
- },
- "type": "array"
- },
- "operatingSystems": {
- "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
- "items": {
- "$ref": "OperatingSystem"
- },
- "type": "array"
- },
- "platformTypes": {
- "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "PlatformType"
- },
- "type": "array"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "ThirdPartyAuthenticationToken": {
- "description": "Third Party Authentication Token",
- "id": "ThirdPartyAuthenticationToken",
- "properties": {
- "name": {
- "description": "Name of the third-party authentication token.",
- "type": "string"
- },
- "value": {
- "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
- "type": "string"
- }
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
- "type": "object"
- },
- "ThirdPartyTrackingUrl": {
- "description": "Third-party Tracking URL.",
- "id": "ThirdPartyTrackingUrl",
- "properties": {
- "thirdPartyUrlType": {
- "description": "Third-party URL type for in-stream video and in-stream audio creatives.",
- "enum": [
- "IMPRESSION",
- "CLICK_TRACKING",
- "VIDEO_START",
- "VIDEO_FIRST_QUARTILE",
- "VIDEO_MIDPOINT",
- "VIDEO_THIRD_QUARTILE",
- "VIDEO_COMPLETE",
- "VIDEO_MUTE",
- "VIDEO_PAUSE",
- "VIDEO_REWIND",
- "VIDEO_FULLSCREEN",
- "VIDEO_STOP",
- "VIDEO_CUSTOM",
- "SURVEY",
- "RICH_MEDIA_IMPRESSION",
- "RICH_MEDIA_RM_IMPRESSION",
- "RICH_MEDIA_BACKUP_IMPRESSION",
- "VIDEO_SKIP",
- "VIDEO_PROGRESS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "url": {
- "description": "URL for the specified third-party URL type.",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "TranscodeSetting": {
- "description": "Transcode Settings",
- "id": "TranscodeSetting",
- "properties": {
- "enabledVideoFormats": {
- "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
- "type": "string"
- }
+ "perInteractionDimensions": {
+ "description": "The list of per interaction dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UniversalAdId": {
- "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
- "id": "UniversalAdId",
- "properties": {
- "registry": {
- "description": "Registry used for the Ad ID value.",
- "enum": [
- "OTHER",
- "AD_ID_OFFICIAL",
- "CLEARCAST",
- "DCM"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
- "type": "string"
- }
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "clicksLookbackWindow": {
+ "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionsLookbackWindow": {
+ "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "includeAttributedIPConversions": {
+ "description": "Deprecated: has no effect.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ },
+ "maximumClickInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumImpressionInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumInteractionGap": {
+ "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pivotOnInteractionPath": {
+ "description": "Enable pivoting on interaction path.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "reachCriteria": {
+ "description": "The report criteria for a report of type \"REACH\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
},
- "type": "object"
- },
- "UserDefinedVariableConfiguration": {
- "description": "User Defined Variable configuration.",
- "id": "UserDefinedVariableConfiguration",
- "properties": {
- "dataType": {
- "description": "Data type for the variable. This is a required field.",
- "enum": [
- "STRING",
- "NUMBER"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "type": "string"
- },
- "reportName": {
- "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".",
- "type": "string"
- },
- "variableType": {
- "description": "Variable name in the tag. This is a required field.",
- "enum": [
- "U1",
- "U2",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U20",
- "U21",
- "U22",
- "U23",
- "U24",
- "U25",
- "U26",
- "U27",
- "U28",
- "U29",
- "U30",
- "U31",
- "U32",
- "U33",
- "U34",
- "U35",
- "U36",
- "U37",
- "U38",
- "U39",
- "U40",
- "U41",
- "U42",
- "U43",
- "U44",
- "U45",
- "U46",
- "U47",
- "U48",
- "U49",
- "U50",
- "U51",
- "U52",
- "U53",
- "U54",
- "U55",
- "U56",
- "U57",
- "U58",
- "U59",
- "U60",
- "U61",
- "U62",
- "U63",
- "U64",
- "U65",
- "U66",
- "U67",
- "U68",
- "U69",
- "U70",
- "U71",
- "U72",
- "U73",
- "U74",
- "U75",
- "U76",
- "U77",
- "U78",
- "U79",
- "U80",
- "U81",
- "U82",
- "U83",
- "U84",
- "U85",
- "U86",
- "U87",
- "U88",
- "U89",
- "U90",
- "U91",
- "U92",
- "U93",
- "U94",
- "U95",
- "U96",
- "U97",
- "U98",
- "U99",
- "U100"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
},
- "type": "object"
- },
- "UserProfile": {
- "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
- "id": "UserProfile",
- "properties": {
- "accountId": {
- "description": "The account ID to which this profile belongs.",
- "format": "int64",
- "type": "string"
- },
- "accountName": {
- "description": "The account name this profile belongs to.",
- "type": "string"
- },
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".",
- "type": "string"
- },
- "profileId": {
- "description": "The unique ID of the user profile.",
- "format": "int64",
- "type": "string"
- },
- "subAccountId": {
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64",
- "type": "string"
- },
- "subAccountName": {
- "description": "The sub account name this profile belongs to if applicable.",
- "type": "string"
- },
- "userName": {
- "description": "The user name.",
- "type": "string"
- }
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
},
- "type": "object"
- },
- "UserProfileList": {
- "description": "Represents the list of user profiles.",
- "id": "UserProfileList",
- "properties": {
- "etag": {
- "description": "Etag of this resource.",
- "type": "string"
- },
- "items": {
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
- "type": "string"
- }
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserRole": {
- "description": "Contains properties of auser role, which is used to manage user access.",
- "id": "UserRole",
- "properties": {
- "accountId": {
- "description": "Account ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- },
- "defaultUserRole": {
- "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this user role. This is a read-only, auto-generated field.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
- "type": "string"
- },
- "parentUserRoleId": {
- "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
- "format": "int64",
- "type": "string"
- },
- "permissions": {
- "description": "List of permissions associated with this user role.",
- "items": {
- "$ref": "UserRolePermission"
- },
- "type": "array"
- },
- "subaccountId": {
- "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64",
- "type": "string"
- }
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserRolePermission": {
- "description": "Contains properties of a user role permission.",
- "id": "UserRolePermission",
- "properties": {
- "availability": {
- "description": "Levels of availability for a user role permission.",
- "enum": [
- "NOT_AVAILABLE_BY_DEFAULT",
- "ACCOUNT_BY_DEFAULT",
- "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
- "ACCOUNT_ALWAYS",
- "SUBACCOUNT_AND_ACCOUNT_ALWAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of this user role permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role permission.",
- "type": "string"
- },
- "permissionGroupId": {
- "description": "ID of the permission group that this user role permission belongs to.",
- "format": "int64",
- "type": "string"
- }
+ "enableAllDimensionCombinations": {
+ "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
+ "type": "boolean"
},
- "type": "object"
- },
- "UserRolePermissionGroup": {
- "description": "Represents a grouping of related user role permissions.",
- "id": "UserRolePermissionGroup",
- "properties": {
- "id": {
- "description": "ID of this user role permission.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
- "type": "string"
- },
- "name": {
- "description": "Name of this user role permission group.",
- "type": "string"
- }
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "UserRolePermissionGroupsListResponse": {
- "description": "User Role Permission Group List Response",
- "id": "UserRolePermissionGroupsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
- "type": "string"
- },
- "userRolePermissionGroups": {
- "description": "User role permission group collection.",
- "items": {
- "$ref": "UserRolePermissionGroup"
- },
- "type": "array"
- }
+ "reachByFrequencyMetricNames": {
+ "description": "The list of names of Reach By Frequency metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schedule": {
+ "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
+ "properties": {
+ "active": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "Whether the schedule is active or not. Must be set to either true or false.",
+ "type": "boolean"
},
- "type": "object"
- },
- "UserRolePermissionsListResponse": {
- "description": "User Role Permission List Response",
- "id": "UserRolePermissionsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
- "type": "string"
- },
- "userRolePermissions": {
- "description": "User role permission collection.",
- "items": {
- "$ref": "UserRolePermission"
- },
- "type": "array"
- }
+ "every": {
+ "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
+ "format": "int32",
+ "type": "integer"
},
- "type": "object"
- },
- "UserRolesListResponse": {
- "description": "User Role List Response",
- "id": "UserRolesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Pagination token to be used for the next list operation.",
- "type": "string"
- },
- "userRoles": {
- "description": "User role collection.",
- "items": {
- "$ref": "UserRole"
- },
- "type": "array"
- }
+ "expirationDate": {
+ "format": "date",
+ "type": "string"
},
- "type": "object"
- },
- "VideoFormat": {
- "description": "Contains information about supported video formats.",
- "id": "VideoFormat",
- "properties": {
- "fileType": {
- "description": "File type of the video format.",
- "enum": [
- "FLV",
- "THREEGPP",
- "MP4",
- "WEBM",
- "M3U8"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "id": {
- "description": "ID of the video format.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
- "type": "string"
- },
- "resolution": {
- "$ref": "Size",
- "description": "The resolution of this video format."
- },
- "targetBitRate": {
- "description": "The target bit rate of this video format.",
- "format": "int32",
- "type": "integer"
- }
+ "repeats": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ",
+ "type": "string"
},
- "type": "object"
- },
- "VideoFormatsListResponse": {
- "description": "Video Format List Response",
- "id": "VideoFormatsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".",
- "type": "string"
- },
- "videoFormats": {
- "description": "Video format collection.",
- "items": {
- "$ref": "VideoFormat"
- },
- "type": "array"
- }
+ "repeatsOnWeekDays": {
+ "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
+ "items": {
+ "enum": [
+ "SUNDAY",
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
- "type": "object"
- },
- "VideoOffset": {
- "description": "Video Offset",
- "id": "VideoOffset",
- "properties": {
- "offsetPercentage": {
- "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "offsetSeconds": {
- "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.",
- "format": "int32",
- "type": "integer"
- }
+ "runsOnDayOfMonth": {
+ "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
+ "enum": [
+ "DAY_OF_MONTH",
+ "WEEK_OF_MONTH"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
},
- "type": "object"
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "subAccountId": {
+ "description": "The subaccount ID to which this report belongs if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The type of the report.",
+ "enum": [
+ "STANDARD",
+ "REACH",
+ "PATH_TO_CONVERSION",
+ "CROSS_DIMENSION_REACH",
+ "FLOODLIGHT",
+ "PATH",
+ "PATH_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
+ "id": "ReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportList": {
+ "description": "Represents the list of reports.",
+ "id": "ReportList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The reports returned in this response.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#reportList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportsConfiguration": {
+ "description": "Reporting Configuration",
+ "id": "ReportsConfiguration",
+ "properties": {
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Default lookback windows for new advertisers in this account."
+ },
+ "reportGenerationTimeZoneId": {
+ "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RichMediaExitOverride": {
+ "description": "Rich Media Exit Override.",
+ "id": "RichMediaExitOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
+ },
+ "enabled": {
+ "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.",
+ "type": "boolean"
+ },
+ "exitId": {
+ "description": "ID for the override to refer to a specific exit in the creative.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Rule": {
+ "description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "Rule",
+ "properties": {
+ "assetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "A user-friendly name for this rule. This is a required field.",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Site": {
+ "description": "Contains properties of a site.",
+ "id": "Site",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approved": {
+ "description": "Whether this site is approved.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this site. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.",
+ "type": "string"
+ },
+ "siteContacts": {
+ "description": "Site contacts.",
+ "items": {
+ "$ref": "SiteContact"
+ },
+ "type": "array"
+ },
+ "siteSettings": {
+ "$ref": "SiteSettings",
+ "description": "Site-wide settings."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "videoSettings": {
+ "$ref": "SiteVideoSettings",
+ "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
+ }
+ },
+ "type": "object"
+ },
+ "SiteCompanionSetting": {
+ "description": "Companion Settings",
+ "id": "SiteCompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this site template.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteContact": {
+ "description": "Site Contact",
+ "id": "SiteContact",
+ "properties": {
+ "address": {
+ "description": "Address of this site contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Site contact type.",
+ "enum": [
+ "SALES_PERSON",
+ "TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "description": "Email address of this site contact. This is a required field.",
+ "type": "string"
+ },
+ "firstName": {
+ "description": "First name of this site contact.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this site contact. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastName": {
+ "description": "Last name of this site contact.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "Primary phone number of this site contact.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title or designation of this site contact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSettings": {
+ "description": "Site Settings",
+ "id": "SiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether active view creatives are disabled for this site.",
+ "type": "boolean"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.",
+ "type": "boolean"
+ },
+ "disableNewCookie": {
+ "description": "Whether new cookies are disabled for this site.",
+ "type": "boolean"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "videoActiveViewOptOutTemplate": {
+ "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
+ "type": "boolean"
+ },
+ "vpaidAdapterChoiceTemplate": {
+ "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SiteSkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SiteTranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "SiteTranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteVideoSettings": {
+ "description": "Video Settings",
+ "id": "SiteVideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "SiteCompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this site."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".",
+ "type": "string"
+ },
+ "obaEnabled": {
+ "description": "Whether OBA icons are enabled for this placement.",
+ "type": "boolean"
+ },
+ "obaSettings": {
+ "$ref": "ObaIcon",
+ "description": "Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site."
+ },
+ "orientation": {
+ "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SiteSkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site."
+ },
+ "transcodeSettings": {
+ "$ref": "SiteTranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site."
+ }
+ },
+ "type": "object"
+ },
+ "SitesListResponse": {
+ "description": "Site List Response",
+ "id": "SitesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
},
- "VideoSettings": {
- "description": "Video Settings",
- "id": "VideoSettings",
- "properties": {
- "companionSettings": {
- "$ref": "CompanionSetting",
- "description": "Settings for the companion creatives of video creatives served to this placement."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
- "type": "string"
- },
- "obaEnabled": {
- "description": "Whether OBA icons are enabled for this placement.",
- "type": "boolean"
- },
- "obaSettings": {
- "$ref": "ObaIcon",
- "description": "Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden."
- },
- "orientation": {
- "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
- "enum": [
- "ANY",
- "LANDSCAPE",
- "PORTRAIT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "skippableSettings": {
- "$ref": "SkippableSetting",
- "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden."
- },
- "transcodeSettings": {
- "$ref": "TranscodeSetting",
- "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
- }
- },
- "type": "object"
+ "sites": {
+ "description": "Site collection.",
+ "items": {
+ "$ref": "Site"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Size": {
+ "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
+ "id": "Size",
+ "properties": {
+ "height": {
+ "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "iab": {
+ "description": "IAB standard size. This is a read-only, auto-generated field.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this size. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SizesListResponse": {
+ "description": "Size List Response",
+ "id": "SizesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
+ "type": "string"
+ },
+ "sizes": {
+ "description": "Size collection.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this placement.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SortedDimension": {
+ "description": "Represents a sorted dimension.",
+ "id": "SortedDimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "An optional sort order for the dimension column.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Subaccount": {
+ "description": "Contains properties of a Campaign Manager subaccount.",
+ "id": "Subaccount",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "availablePermissionIds": {
+ "description": "IDs of the available user role permissions for this subaccount.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this subaccount. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubaccountsListResponse": {
+ "description": "Subaccount List Response",
+ "id": "SubaccountsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "subaccounts": {
+ "description": "Subaccount collection.",
+ "items": {
+ "$ref": "Subaccount"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagData": {
+ "description": "Placement Tag Data",
+ "id": "TagData",
+ "properties": {
+ "adId": {
+ "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickTag": {
+ "description": "Tag string to record a click.",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "format": {
+ "description": "TagData tag format of this tag.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "impressionTag": {
+ "description": "Tag string for serving an ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSetting": {
+ "description": "Tag Settings",
+ "id": "TagSetting",
+ "properties": {
+ "additionalKeyValues": {
+ "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.",
+ "type": "string"
+ },
+ "includeClickThroughUrls": {
+ "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.",
+ "type": "boolean"
+ },
+ "includeClickTracking": {
+ "description": "Whether click-tracking string should be included in the tags.",
+ "type": "boolean"
+ },
+ "keywordOption": {
+ "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
+ "enum": [
+ "PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
+ "IGNORE",
+ "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSettings": {
+ "description": "Dynamic and Image Tag Settings.",
+ "id": "TagSettings",
+ "properties": {
+ "dynamicTagEnabled": {
+ "description": "Whether dynamic floodlight tags are enabled.",
+ "type": "boolean"
+ },
+ "imageTagEnabled": {
+ "description": "Whether image tags are enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "TargetWindow": {
+ "description": "Target Window.",
+ "id": "TargetWindow",
+ "properties": {
+ "customHtml": {
+ "description": "User-entered value.",
+ "type": "string"
+ },
+ "targetWindowOption": {
+ "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
+ "enum": [
+ "NEW_WINDOW",
+ "CURRENT_WINDOW",
+ "CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetableRemarketingList": {
+ "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
+ "id": "TargetableRemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this targetable remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser."
+ },
+ "description": {
+ "description": "Targetable remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Targetable remarketing list ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this targetable remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "dfareporting/v3.4/",
- "title": "Campaign Manager 360 API",
- "version": "v3.4"
+ "TargetableRemarketingListsListResponse": {
+ "description": "Targetable remarketing list response",
+ "id": "TargetableRemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetableRemarketingLists": {
+ "description": "Targetable remarketing list collection.",
+ "items": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplate": {
+ "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.",
+ "id": "TargetingTemplate",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting criteria."
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting criteria."
+ },
+ "id": {
+ "description": "ID of this targeting template. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting criteria."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting criteria."
+ },
+ "listTargetingExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting criteria."
+ },
+ "name": {
+ "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting criteria."
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplatesListResponse": {
+ "description": "Targeting Template List Response",
+ "id": "TargetingTemplatesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetingTemplates": {
+ "description": "Targeting template collection.",
+ "items": {
+ "$ref": "TargetingTemplate"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TechnologyTargeting": {
+ "description": "Technology Targeting.",
+ "id": "TechnologyTargeting",
+ "properties": {
+ "browsers": {
+ "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "connectionTypes": {
+ "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ },
+ "operatingSystems": {
+ "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ },
+ "platformTypes": {
+ "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyAuthenticationToken": {
+ "description": "Third Party Authentication Token",
+ "id": "ThirdPartyAuthenticationToken",
+ "properties": {
+ "name": {
+ "description": "Name of the third-party authentication token.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyTrackingUrl": {
+ "description": "Third-party Tracking URL.",
+ "id": "ThirdPartyTrackingUrl",
+ "properties": {
+ "thirdPartyUrlType": {
+ "description": "Third-party URL type for in-stream video and in-stream audio creatives.",
+ "enum": [
+ "IMPRESSION",
+ "CLICK_TRACKING",
+ "VIDEO_START",
+ "VIDEO_FIRST_QUARTILE",
+ "VIDEO_MIDPOINT",
+ "VIDEO_THIRD_QUARTILE",
+ "VIDEO_COMPLETE",
+ "VIDEO_MUTE",
+ "VIDEO_PAUSE",
+ "VIDEO_REWIND",
+ "VIDEO_FULLSCREEN",
+ "VIDEO_STOP",
+ "VIDEO_CUSTOM",
+ "SURVEY",
+ "RICH_MEDIA_IMPRESSION",
+ "RICH_MEDIA_RM_IMPRESSION",
+ "RICH_MEDIA_BACKUP_IMPRESSION",
+ "VIDEO_SKIP",
+ "VIDEO_PROGRESS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the specified third-party URL type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "TranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UniversalAdId": {
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
+ "id": "UniversalAdId",
+ "properties": {
+ "registry": {
+ "description": "Registry used for the Ad ID value.",
+ "enum": [
+ "OTHER",
+ "AD_ID_OFFICIAL",
+ "CLEARCAST",
+ "DCM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserDefinedVariableConfiguration": {
+ "description": "User Defined Variable configuration.",
+ "id": "UserDefinedVariableConfiguration",
+ "properties": {
+ "dataType": {
+ "description": "Data type for the variable. This is a required field.",
+ "enum": [
+ "STRING",
+ "NUMBER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "reportName": {
+ "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".",
+ "type": "string"
+ },
+ "variableType": {
+ "description": "Variable name in the tag. This is a required field.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfile": {
+ "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
+ "id": "UserProfile",
+ "properties": {
+ "accountId": {
+ "description": "The account ID to which this profile belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "accountName": {
+ "description": "The account name this profile belongs to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The unique ID of the user profile.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountId": {
+ "description": "The sub account ID this profile belongs to if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountName": {
+ "description": "The sub account name this profile belongs to if applicable.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "The user name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfileList": {
+ "description": "Represents the list of user profiles.",
+ "id": "UserProfileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The user profiles returned in this response.",
+ "items": {
+ "$ref": "UserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRole": {
+ "description": "Contains properties of auser role, which is used to manage user access.",
+ "id": "UserRole",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultUserRole": {
+ "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this user role. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
+ "type": "string"
+ },
+ "parentUserRoleId": {
+ "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "List of permissions associated with this user role.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermission": {
+ "description": "Contains properties of a user role permission.",
+ "id": "UserRolePermission",
+ "properties": {
+ "availability": {
+ "description": "Levels of availability for a user role permission.",
+ "enum": [
+ "NOT_AVAILABLE_BY_DEFAULT",
+ "ACCOUNT_BY_DEFAULT",
+ "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
+ "ACCOUNT_ALWAYS",
+ "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
+ "USER_PROFILE_ONLY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "ID of the permission group that this user role permission belongs to.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroup": {
+ "description": "Represents a grouping of related user role permissions.",
+ "id": "UserRolePermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroupsListResponse": {
+ "description": "User Role Permission Group List Response",
+ "id": "UserRolePermissionGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissionGroups": {
+ "description": "User role permission group collection.",
+ "items": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionsListResponse": {
+ "description": "User Role Permission List Response",
+ "id": "UserRolePermissionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissions": {
+ "description": "User role permission collection.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolesListResponse": {
+ "description": "User Role List Response",
+ "id": "UserRolesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "userRoles": {
+ "description": "User role collection.",
+ "items": {
+ "$ref": "UserRole"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormat": {
+ "description": "Contains information about supported video formats.",
+ "id": "VideoFormat",
+ "properties": {
+ "fileType": {
+ "description": "File type of the video format.",
+ "enum": [
+ "FLV",
+ "THREEGPP",
+ "MP4",
+ "WEBM",
+ "M3U8"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the video format.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
+ "type": "string"
+ },
+ "resolution": {
+ "$ref": "Size",
+ "description": "The resolution of this video format."
+ },
+ "targetBitRate": {
+ "description": "The target bit rate of this video format.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormatsListResponse": {
+ "description": "Video Format List Response",
+ "id": "VideoFormatsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".",
+ "type": "string"
+ },
+ "videoFormats": {
+ "description": "Video format collection.",
+ "items": {
+ "$ref": "VideoFormat"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoOffset": {
+ "description": "Video Offset",
+ "id": "VideoOffset",
+ "properties": {
+ "offsetPercentage": {
+ "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetSeconds": {
+ "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoSettings": {
+ "description": "Video Settings",
+ "id": "VideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "CompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this placement."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
+ "type": "string"
+ },
+ "obaEnabled": {
+ "description": "Whether OBA icons are enabled for this placement.",
+ "type": "boolean"
+ },
+ "obaSettings": {
+ "$ref": "ObaIcon",
+ "description": "Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden."
+ },
+ "orientation": {
+ "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden."
+ },
+ "transcodeSettings": {
+ "$ref": "TranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "dfareporting/v3.4/",
+ "title": "Campaign Manager 360 API",
+ "version": "v3.4"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json b/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json
new file mode 100644
index 00000000000..3dac37a8379
--- /dev/null
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json
@@ -0,0 +1,20538 @@
+{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/ddmconversions": {
+ "description": "Manage DoubleClick Digital Marketing conversions"
+ },
+ "https://www.googleapis.com/auth/dfareporting": {
+ "description": "View and manage DoubleClick for Advertisers reports"
+ },
+ "https://www.googleapis.com/auth/dfatrafficking": {
+ "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://dfareporting.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Dfareporting",
+ "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "dfareporting:v3.5",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
+ "name": "dfareporting",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accountActiveAdSummaries": {
+ "methods": {
+ "get": {
+ "description": "Gets the account's active ad summary by account ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountActiveAdSummaries.get",
+ "parameterOrder": [
+ "profileId",
+ "summaryAccountId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "summaryAccountId": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
+ "response": {
+ "$ref": "AccountActiveAdSummary"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissionGroups/{id}",
+ "response": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permission groups.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissionGroups",
+ "response": {
+ "$ref": "AccountPermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountPermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one account permission by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissions/{id}",
+ "response": {
+ "$ref": "AccountPermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of account permissions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountPermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountPermissions",
+ "response": {
+ "$ref": "AccountPermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accountUserProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one account user profile by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles/{id}",
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new account user profile.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "POST",
+ "id": "dfareporting.accountUserProfiles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.accountUserProfiles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active user profiles.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user profiles with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user profiles with the specified subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "userRoleId": {
+ "description": "Select only user profiles with the specified user role ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "response": {
+ "$ref": "AccountUserProfilesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account user profile. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accountUserProfiles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AccountUserProfile ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account user profile.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accountUserProfiles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accountUserProfiles",
+ "request": {
+ "$ref": "AccountUserProfile"
+ },
+ "response": {
+ "$ref": "AccountUserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.accounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only accounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "response": {
+ "$ref": "AccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.accounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Account ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.accounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/accounts",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "ads": {
+ "methods": {
+ "get": {
+ "description": "Gets one ad by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/ads/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/ads/{id}",
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new ad.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "httpMethod": "POST",
+ "id": "dfareporting.ads.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "httpMethod": "GET",
+ "id": "dfareporting.ads.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only ads with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived ads.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "audienceSegmentIds": {
+ "description": "Select only ads with these audience segment IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "campaignIds": {
+ "description": "Select only ads with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "creativeIds": {
+ "description": "Select only ads with these creative IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "creativeOptimizationConfigurationIds": {
+ "description": "Select only ads with these creative optimization configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dynamicClickTracker": {
+ "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only ads with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "landingPageIds": {
+ "description": "Select only ads with these landing page IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only ads with this event tag override ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Select only ads with these placement IDs assigned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListIds": {
+ "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only ads with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sslCompliant": {
+ "description": "Select only ads that are SSL-compliant.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Select only ads that require SSL.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Select only ads with these types.",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "response": {
+ "$ref": "AdsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing ad. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.ads.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Ad ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing ad.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "httpMethod": "PUT",
+ "id": "dfareporting.ads.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/ads",
+ "request": {
+ "$ref": "Ad"
+ },
+ "response": {
+ "$ref": "Ad"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserGroups": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing advertiser group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.advertiserGroups.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one advertiser group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups/{id}",
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only advertiser groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "response": {
+ "$ref": "AdvertiserGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser group. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "AdvertiserGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserGroups",
+ "request": {
+ "$ref": "AdvertiserGroup"
+ },
+ "response": {
+ "$ref": "AdvertiserGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertiserLandingPages": {
+ "methods": {
+ "get": {
+ "description": "Gets one landing page by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Landing page ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages/{id}",
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new landing page.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertiserLandingPages.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of landing pages.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertiserLandingPages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only landing pages that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only landing pages that are associated with these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only landing pages with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only landing pages that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "response": {
+ "$ref": "AdvertiserLandingPagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser landing page. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertiserLandingPages.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "LandingPage ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing landing page.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertiserLandingPages.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertiserLandingPages",
+ "request": {
+ "$ref": "LandingPage"
+ },
+ "response": {
+ "$ref": "LandingPage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "advertisers": {
+ "methods": {
+ "get": {
+ "description": "Gets one advertiser by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertisers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertisers/{id}",
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new advertiser.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "httpMethod": "POST",
+ "id": "dfareporting.advertisers.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "httpMethod": "GET",
+ "id": "dfareporting.advertisers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only advertisers with these advertiser group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "floodlightConfigurationIds": {
+ "description": "Select only advertisers with these floodlight configuration IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only advertisers with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "includeAdvertisersWithoutGroupsOnly": {
+ "description": "Select only advertisers which do not belong to any advertiser group.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "onlyParent": {
+ "description": "Select only advertisers which use another advertiser's floodlight configuration.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Select only advertisers with the specified status.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only advertisers with these subaccount IDs.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "response": {
+ "$ref": "AdvertisersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing advertiser. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.advertisers.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing advertiser.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "httpMethod": "PUT",
+ "id": "dfareporting.advertisers.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/advertisers",
+ "request": {
+ "$ref": "Advertiser"
+ },
+ "response": {
+ "$ref": "Advertiser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "browsers": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of browsers.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/browsers",
+ "httpMethod": "GET",
+ "id": "dfareporting.browsers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/browsers",
+ "response": {
+ "$ref": "BrowsersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaignCreativeAssociations": {
+ "methods": {
+ "insert": {
+ "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaignCreativeAssociations.insert",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "request": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "response": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaignCreativeAssociations.list",
+ "parameterOrder": [
+ "profileId",
+ "campaignId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Campaign ID in this association.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
+ "response": {
+ "$ref": "CampaignCreativeAssociationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "campaigns": {
+ "methods": {
+ "get": {
+ "description": "Gets one campaign by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns/{id}",
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new campaign.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "httpMethod": "POST",
+ "id": "dfareporting.campaigns.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "httpMethod": "GET",
+ "id": "dfareporting.campaigns.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserGroupIds": {
+ "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "advertiserIds": {
+ "description": "Select only campaigns that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "atLeastOneOptimizationActivity": {
+ "description": "Select only campaigns that have at least one optimization activity.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "excludedIds": {
+ "description": "Exclude campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only campaigns with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "overriddenEventTagId": {
+ "description": "Select only campaigns that have overridden this event tag ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only campaigns that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "response": {
+ "$ref": "CampaignsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing campaign. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.campaigns.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing campaign.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "httpMethod": "PUT",
+ "id": "dfareporting.campaigns.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/campaigns",
+ "request": {
+ "$ref": "Campaign"
+ },
+ "response": {
+ "$ref": "Campaign"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "changeLogs": {
+ "methods": {
+ "get": {
+ "description": "Gets one change log by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/changeLogs/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Change log ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/changeLogs/{id}",
+ "response": {
+ "$ref": "ChangeLog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of change logs. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/changeLogs",
+ "httpMethod": "GET",
+ "id": "dfareporting.changeLogs.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "action": {
+ "description": "Select only change logs with the specified action.",
+ "enum": [
+ "ACTION_CREATE",
+ "ACTION_UPDATE",
+ "ACTION_DELETE",
+ "ACTION_ENABLE",
+ "ACTION_DISABLE",
+ "ACTION_ADD",
+ "ACTION_REMOVE",
+ "ACTION_MARK_AS_DEFAULT",
+ "ACTION_ASSOCIATE",
+ "ACTION_ASSIGN",
+ "ACTION_UNASSIGN",
+ "ACTION_SEND",
+ "ACTION_LINK",
+ "ACTION_UNLINK",
+ "ACTION_PUSH",
+ "ACTION_EMAIL_TAGS",
+ "ACTION_SHARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only change logs with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxChangeTime": {
+ "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "minChangeTime": {
+ "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
+ "location": "query",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Select only change logs with these object IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Select only change logs with the specified object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_FLOODLIGHT_CONFIGURATION",
+ "OBJECT_AD",
+ "OBJECT_FLOODLIGHT_ACTVITY",
+ "OBJECT_CAMPAIGN",
+ "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT",
+ "OBJECT_DFA_SITE",
+ "OBJECT_USER_ROLE",
+ "OBJECT_USER_PROFILE",
+ "OBJECT_ADVERTISER_GROUP",
+ "OBJECT_ACCOUNT",
+ "OBJECT_SUBACCOUNT",
+ "OBJECT_RICHMEDIA_CREATIVE",
+ "OBJECT_INSTREAM_CREATIVE",
+ "OBJECT_MEDIA_ORDER",
+ "OBJECT_CONTENT_CATEGORY",
+ "OBJECT_PLACEMENT_STRATEGY",
+ "OBJECT_SD_SITE",
+ "OBJECT_SIZE",
+ "OBJECT_CREATIVE_GROUP",
+ "OBJECT_CREATIVE_ASSET",
+ "OBJECT_USER_PROFILE_FILTER",
+ "OBJECT_LANDING_PAGE",
+ "OBJECT_CREATIVE_FIELD",
+ "OBJECT_REMARKETING_LIST",
+ "OBJECT_PROVIDED_LIST_CLIENT",
+ "OBJECT_EVENT_TAG",
+ "OBJECT_CREATIVE_BUNDLE",
+ "OBJECT_BILLING_ACCOUNT_GROUP",
+ "OBJECT_BILLING_FEATURE",
+ "OBJECT_RATE_CARD",
+ "OBJECT_ACCOUNT_BILLING_FEATURE",
+ "OBJECT_BILLING_MINIMUM_FEE",
+ "OBJECT_BILLING_PROFILE",
+ "OBJECT_PLAYSTORE_LINK",
+ "OBJECT_TARGETING_TEMPLATE",
+ "OBJECT_SEARCH_LIFT_STUDY",
+ "OBJECT_FLOODLIGHT_DV360_LINK"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
+ "location": "query",
+ "type": "string"
+ },
+ "userProfileIds": {
+ "description": "Select only change logs with these user profile IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/changeLogs",
+ "response": {
+ "$ref": "ChangeLogsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "cities": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of cities, possibly filtered.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/cities",
+ "httpMethod": "GET",
+ "id": "dfareporting.cities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "countryDartIds": {
+ "description": "Select only cities from these countries.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dartIds": {
+ "description": "Select only cities with these DART IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "namePrefix": {
+ "description": "Select only cities with names starting with this prefix.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "regionDartIds": {
+ "description": "Select only cities from these regions.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/cities",
+ "response": {
+ "$ref": "CitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "connectionTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one connection type by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/connectionTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Connection type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/connectionTypes/{id}",
+ "response": {
+ "$ref": "ConnectionType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of connection types.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/connectionTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.connectionTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/connectionTypes",
+ "response": {
+ "$ref": "ConnectionTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "contentCategories": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing content category.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.contentCategories.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one content category by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Content category ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories/{id}",
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new content category.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "httpMethod": "POST",
+ "id": "dfareporting.contentCategories.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "httpMethod": "GET",
+ "id": "dfareporting.contentCategories.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only content categories with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "response": {
+ "$ref": "ContentCategoriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing content category. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.contentCategories.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ContentCategory ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing content category.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "httpMethod": "PUT",
+ "id": "dfareporting.contentCategories.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/contentCategories",
+ "request": {
+ "$ref": "ContentCategory"
+ },
+ "response": {
+ "$ref": "ContentCategory"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "conversions": {
+ "methods": {
+ "batchinsert": {
+ "description": "Inserts conversions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/conversions/batchinsert",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchinsert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/conversions/batchinsert",
+ "request": {
+ "$ref": "ConversionsBatchInsertRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchInsertResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ },
+ "batchupdate": {
+ "description": "Updates existing conversions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/conversions/batchupdate",
+ "httpMethod": "POST",
+ "id": "dfareporting.conversions.batchupdate",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/conversions/batchupdate",
+ "request": {
+ "$ref": "ConversionsBatchUpdateRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchUpdateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ }
+ }
+ },
+ "countries": {
+ "methods": {
+ "get": {
+ "description": "Gets one country by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/countries/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Country DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/countries/{dartId}",
+ "response": {
+ "$ref": "Country"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of countries.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/countries",
+ "httpMethod": "GET",
+ "id": "dfareporting.countries.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/countries",
+ "response": {
+ "$ref": "CountriesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeAssets": {
+ "methods": {
+ "insert": {
+ "description": "Inserts a new creative asset.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeAssets.insert",
+ "mediaUpload": {
+ "accept": [
+ "*/*"
+ ],
+ "maxSize": "1073741824",
+ "protocols": {
+ "simple": {
+ "multipart": true,
+ "path": "/upload/dfareporting/v3.5/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
+ }
+ }
+ },
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
+ "request": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "response": {
+ "$ref": "CreativeAssetMetadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "creativeFieldValues": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field value.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFieldValues.delete",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field value by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.get",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Creative Field Value ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field value.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFieldValues.insert",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFieldValues.list",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only creative field values with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "VALUE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "response": {
+ "$ref": "CreativeFieldValuesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field value. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFieldValues.patch",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId",
+ "id"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "CreativeFieldValue ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field value.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFieldValues.update",
+ "parameterOrder": [
+ "profileId",
+ "creativeFieldId"
+ ],
+ "parameters": {
+ "creativeFieldId": {
+ "description": "Creative field ID for this creative field value.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
+ "request": {
+ "$ref": "CreativeFieldValue"
+ },
+ "response": {
+ "$ref": "CreativeFieldValue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeFields": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing creative field.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.creativeFields.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one creative field by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative Field ID",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields/{id}",
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative field.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeFields.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeFields.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative fields that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only creative fields with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "response": {
+ "$ref": "CreativeFieldsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative field. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeFields.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeField ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative field.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeFields.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeFields",
+ "request": {
+ "$ref": "CreativeField"
+ },
+ "response": {
+ "$ref": "CreativeField"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creativeGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups/{id}",
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.creativeGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.creativeGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only creative groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "groupNumber": {
+ "description": "Select only creative groups that belong to this subgroup.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "2",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "ids": {
+ "description": "Select only creative groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "response": {
+ "$ref": "CreativeGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative group. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creativeGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "CreativeGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creativeGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creativeGroups",
+ "request": {
+ "$ref": "CreativeGroup"
+ },
+ "response": {
+ "$ref": "CreativeGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets one creative by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creatives/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creatives/{id}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new creative.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "httpMethod": "POST",
+ "id": "dfareporting.creatives.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "httpMethod": "GET",
+ "id": "dfareporting.creatives.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only creatives with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Select only creatives with this campaign ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "companionCreativeIds": {
+ "description": "Select only in-stream video creatives with these companion IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "creativeFieldIds": {
+ "description": "Select only creatives with these creative field IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only creatives with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "renderingIds": {
+ "description": "Select only creatives with these rendering IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only creatives with these size IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "studioCreativeId": {
+ "description": "Select only creatives corresponding to this Studio creative ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "types": {
+ "description": "Select only creatives with these creative types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "response": {
+ "$ref": "CreativesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing creative. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.creatives.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Creative ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing creative.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "httpMethod": "PUT",
+ "id": "dfareporting.creatives.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "dimensionValues": {
+ "methods": {
+ "query": {
+ "description": "Retrieves list of report dimension values for a list of filters.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/dimensionvalues/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.dimensionValues.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "100",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/dimensionvalues/query",
+ "request": {
+ "$ref": "DimensionValueRequest"
+ },
+ "response": {
+ "$ref": "DimensionValueList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "directorySites": {
+ "methods": {
+ "get": {
+ "description": "Gets one directory site by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/directorySites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Directory site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/directorySites/{id}",
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new directory site.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/directorySites",
+ "httpMethod": "POST",
+ "id": "dfareporting.directorySites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/directorySites",
+ "request": {
+ "$ref": "DirectorySite"
+ },
+ "response": {
+ "$ref": "DirectorySite"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/directorySites",
+ "httpMethod": "GET",
+ "id": "dfareporting.directorySites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "active": {
+ "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "dfpNetworkCode": {
+ "description": "Select only directory sites with this Ad Manager network code.",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only directory sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/directorySites",
+ "response": {
+ "$ref": "DirectorySitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "dynamicTargetingKeys": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing dynamic targeting key.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.dynamicTargetingKeys.delete",
+ "parameterOrder": [
+ "profileId",
+ "objectId",
+ "name",
+ "objectType"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "POST",
+ "id": "dfareporting.dynamicTargetingKeys.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys",
+ "request": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "response": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of dynamic targeting keys.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "GET",
+ "id": "dfareporting.dynamicTargetingKeys.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "names": {
+ "description": "Select only dynamic targeting keys exactly matching these names.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "objectId": {
+ "description": "Select only dynamic targeting keys with this object ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Select only dynamic targeting keys with this object type.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/dynamicTargetingKeys",
+ "response": {
+ "$ref": "DynamicTargetingKeysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "eventTags": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing event tag.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.eventTags.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one event tag by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Event tag ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags/{id}",
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new event tag.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "httpMethod": "POST",
+ "id": "dfareporting.eventTags.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of event tags, possibly filtered.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "httpMethod": "GET",
+ "id": "dfareporting.eventTags.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "adId": {
+ "description": "Select only event tags that belong to this ad.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Select only event tags that belong to this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "campaignId": {
+ "description": "Select only event tags that belong to this campaign.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "definitionsOnly": {
+ "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "eventTagTypes": {
+ "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only event tags with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "response": {
+ "$ref": "EventTagsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing event tag. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.eventTags.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "EventTag ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing event tag.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "httpMethod": "PUT",
+ "id": "dfareporting.eventTags.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/eventTags",
+ "request": {
+ "$ref": "EventTag"
+ },
+ "response": {
+ "$ref": "EventTag"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "dfareporting/v3.5/reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.get",
+ "parameterOrder": [
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
+ },
+ "list": {
+ "description": "Lists files for a user profile.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.files.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE",
+ "SHARED_WITH_ME"
+ ],
+ "enumDescriptions": [
+ "All files in account.",
+ "My files.",
+ "Files shared with me."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "Sort by file ID.",
+ "Sort by 'lastmodifiedAt' field."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "floodlightActivities": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing floodlight activity.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.floodlightActivities.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "generatetag": {
+ "description": "Generates a tag for a floodlight activity.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/generatetag",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.generatetag",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID for which we want to generate a tag.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/generatetag",
+ "response": {
+ "$ref": "FloodlightActivitiesGenerateTagResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one floodlight activity by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities/{id}",
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivities.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivities.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "floodlightActivityGroupIds": {
+ "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "floodlightActivityGroupName": {
+ "description": "Select only floodlight activities with the specified floodlight activity group name.",
+ "location": "query",
+ "type": "string"
+ },
+ "floodlightActivityGroupTagString": {
+ "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
+ "location": "query",
+ "type": "string"
+ },
+ "floodlightActivityGroupType": {
+ "description": "Select only floodlight activities with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Select only floodlight activities with the specified tag string.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "response": {
+ "$ref": "FloodlightActivitiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivities.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivity ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivities.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivities",
+ "request": {
+ "$ref": "FloodlightActivity"
+ },
+ "response": {
+ "$ref": "FloodlightActivity"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightActivityGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight activity group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight activity Group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups/{id}",
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new floodlight activity group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.floodlightActivityGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightActivityGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "type": {
+ "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "response": {
+ "$ref": "FloodlightActivityGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightActivityGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightActivityGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight activity group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightActivityGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightActivityGroups",
+ "request": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "response": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "floodlightConfigurations": {
+ "methods": {
+ "get": {
+ "description": "Gets one floodlight configuration by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Floodlight configuration ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations/{id}",
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of floodlight configurations, possibly filtered.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "GET",
+ "id": "dfareporting.floodlightConfigurations.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "response": {
+ "$ref": "FloodlightConfigurationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.floodlightConfigurations.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "FloodlightConfiguration ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing floodlight configuration.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "httpMethod": "PUT",
+ "id": "dfareporting.floodlightConfigurations.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/floodlightConfigurations",
+ "request": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "response": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "inventoryItems": {
+ "methods": {
+ "get": {
+ "description": "Gets one inventory item by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Inventory item ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
+ "response": {
+ "$ref": "InventoryItem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "httpMethod": "GET",
+ "id": "dfareporting.inventoryItems.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only inventory items with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "inPlan": {
+ "description": "Select only inventory items that are in plan.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderId": {
+ "description": "Select only inventory items that belong to specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Select only inventory items that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "type": {
+ "description": "Select only inventory items with this type.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/inventoryItems",
+ "response": {
+ "$ref": "InventoryItemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "languages": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of languages.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/languages",
+ "httpMethod": "GET",
+ "id": "dfareporting.languages.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/languages",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "metros": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of metros.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/metros",
+ "httpMethod": "GET",
+ "id": "dfareporting.metros.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/metros",
+ "response": {
+ "$ref": "MetrosListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileApps": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile app by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/mobileApps/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile app ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/mobileApps/{id}",
+ "response": {
+ "$ref": "MobileApp"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of available mobile apps.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/mobileApps",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileApps.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "directories": {
+ "description": "Select only apps from these directories.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only apps with these IDs.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/mobileApps",
+ "response": {
+ "$ref": "MobileAppsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "mobileCarriers": {
+ "methods": {
+ "get": {
+ "description": "Gets one mobile carrier by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/mobileCarriers/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Mobile carrier ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/mobileCarriers/{id}",
+ "response": {
+ "$ref": "MobileCarrier"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of mobile carriers.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/mobileCarriers",
+ "httpMethod": "GET",
+ "id": "dfareporting.mobileCarriers.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/mobileCarriers",
+ "response": {
+ "$ref": "MobileCarriersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystemVersions": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system version by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Operating system version ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystemVersions/{id}",
+ "response": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating system versions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystemVersions",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystemVersions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystemVersions",
+ "response": {
+ "$ref": "OperatingSystemVersionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "operatingSystems": {
+ "methods": {
+ "get": {
+ "description": "Gets one operating system by DART ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystems/{dartId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.get",
+ "parameterOrder": [
+ "profileId",
+ "dartId"
+ ],
+ "parameters": {
+ "dartId": {
+ "description": "Operating system DART ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystems/{dartId}",
+ "response": {
+ "$ref": "OperatingSystem"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of operating systems.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystems",
+ "httpMethod": "GET",
+ "id": "dfareporting.operatingSystems.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/operatingSystems",
+ "response": {
+ "$ref": "OperatingSystemsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orderDocuments": {
+ "methods": {
+ "get": {
+ "description": "Gets one order document by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order document ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
+ "response": {
+ "$ref": "OrderDocument"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "httpMethod": "GET",
+ "id": "dfareporting.orderDocuments.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "approved": {
+ "description": "Select only order documents that have been approved by at least one user.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only order documents with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderId": {
+ "description": "Select only order documents for specified orders.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for order documents.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Select only order documents that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orderDocuments",
+ "response": {
+ "$ref": "OrderDocumentsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "orders": {
+ "methods": {
+ "get": {
+ "description": "Gets one order by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.get",
+ "parameterOrder": [
+ "profileId",
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Order ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orders/{id}",
+ "response": {
+ "$ref": "Order"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orders",
+ "httpMethod": "GET",
+ "id": "dfareporting.orders.list",
+ "parameterOrder": [
+ "profileId",
+ "projectId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only orders with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID for orders.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Select only orders that are associated with these site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{projectId}/orders",
+ "response": {
+ "$ref": "OrdersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one placement group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups/{id}",
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementGroups.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placement groups that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only placement groups that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placement groups that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placement groups that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placement groups with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "800",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "800",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placement groups that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placement groups with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placement groups that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "response": {
+ "$ref": "PlacementGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement group. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementGroups.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementGroup ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement group.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementGroups.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementGroups",
+ "request": {
+ "$ref": "PlacementGroup"
+ },
+ "response": {
+ "$ref": "PlacementGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placementStrategies": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing placement strategy.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.placementStrategies.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement strategy by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement strategy ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies/{id}",
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement strategy.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "POST",
+ "id": "dfareporting.placementStrategies.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "GET",
+ "id": "dfareporting.placementStrategies.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only placement strategies with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "response": {
+ "$ref": "PlacementStrategiesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement strategy. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placementStrategies.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "PlacementStrategy ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement strategy.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placementStrategies.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placementStrategies",
+ "request": {
+ "$ref": "PlacementStrategy"
+ },
+ "response": {
+ "$ref": "PlacementStrategy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "placements": {
+ "methods": {
+ "generatetags": {
+ "description": "Generates tags for a placement.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements/generatetags",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.generatetags",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "campaignId": {
+ "description": "Generate placements belonging to this campaign. This is a required field.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "placementIds": {
+ "description": "Generate tags for these placements.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements/generatetags",
+ "response": {
+ "$ref": "PlacementsGenerateTagsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one placement by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements/{id}",
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new placement.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "httpMethod": "POST",
+ "id": "dfareporting.placements.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "httpMethod": "GET",
+ "id": "dfareporting.placements.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only placements that belong to these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "archived": {
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only placements that belong to these campaigns.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "compatibilities": {
+ "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentCategoryIds": {
+ "description": "Select only placements that are associated with these content categories.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only placements that are associated with these directory sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "groupIds": {
+ "description": "Select only placements that belong to these placement groups.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only placements with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minEndDate": {
+ "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "minStartDate": {
+ "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "paymentSource": {
+ "description": "Select only placements with this payment source.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "placementStrategyIds": {
+ "description": "Select only placements that are associated with these placement strategies.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pricingTypes": {
+ "description": "Select only placements with these pricing types.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Select only placements that are associated with these sites.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sizeIds": {
+ "description": "Select only placements that are associated with these sizes.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "response": {
+ "$ref": "PlacementsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing placement. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.placements.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Placement ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing placement.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "httpMethod": "PUT",
+ "id": "dfareporting.placements.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/placements",
+ "request": {
+ "$ref": "Placement"
+ },
+ "response": {
+ "$ref": "Placement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "platformTypes": {
+ "methods": {
+ "get": {
+ "description": "Gets one platform type by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/platformTypes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Platform type ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/platformTypes/{id}",
+ "response": {
+ "$ref": "PlatformType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of platform types.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/platformTypes",
+ "httpMethod": "GET",
+ "id": "dfareporting.platformTypes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/platformTypes",
+ "response": {
+ "$ref": "PlatformTypesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "postalCodes": {
+ "methods": {
+ "get": {
+ "description": "Gets one postal code by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/postalCodes/{code}",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.get",
+ "parameterOrder": [
+ "profileId",
+ "code"
+ ],
+ "parameters": {
+ "code": {
+ "description": "Postal code ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/postalCodes/{code}",
+ "response": {
+ "$ref": "PostalCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of postal codes.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/postalCodes",
+ "httpMethod": "GET",
+ "id": "dfareporting.postalCodes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/postalCodes",
+ "response": {
+ "$ref": "PostalCodesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "get": {
+ "description": "Gets one project by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Project ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects/{id}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/projects",
+ "httpMethod": "GET",
+ "id": "dfareporting.projects.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserIds": {
+ "description": "Select only projects with these advertiser IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only projects with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/projects",
+ "response": {
+ "$ref": "ProjectsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "regions": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of regions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/regions",
+ "httpMethod": "GET",
+ "id": "dfareporting.regions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/regions",
+ "response": {
+ "$ref": "RegionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingListShares": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list share by remarketing list ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingListShares.get",
+ "parameterOrder": [
+ "profileId",
+ "remarketingListId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list share. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingListShares.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list share.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingListShares.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingListShares",
+ "request": {
+ "$ref": "RemarketingListShare"
+ },
+ "response": {
+ "$ref": "RemarketingListShare"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "remarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists/{id}",
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new remarketing list.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "POST",
+ "id": "dfareporting.remarketingLists.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.remarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only remarketing lists owned by this advertiser.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "floodlightActivityId": {
+ "description": "Select only remarketing lists that have this floodlight activity ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "response": {
+ "$ref": "RemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing list. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.remarketingLists.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "RemarketingList ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing list.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "httpMethod": "PUT",
+ "id": "dfareporting.remarketingLists.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/remarketingLists",
+ "request": {
+ "$ref": "RemarketingList"
+ },
+ "response": {
+ "$ref": "RemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a report by its ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.reports.delete",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a report by its ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "insert": {
+ "description": "Creates a report.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of reports.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "scope": {
+ "default": "MINE",
+ "description": "The scope that defines which results are returned.",
+ "enum": [
+ "ALL",
+ "MINE"
+ ],
+ "enumDescriptions": [
+ "All reports in account.",
+ "My reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "Sort by report ID.",
+ "Sort by 'lastModifiedTime' field.",
+ "Sort by name of reports."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports",
+ "response": {
+ "$ref": "ReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing report. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.reports.patch",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The DFA user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "run": {
+ "description": "Runs a report.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/run",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.run",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "synchronous": {
+ "default": "false",
+ "description": "If set and true, tries to run the report synchronously.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/run",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ },
+ "update": {
+ "description": "Updates a report.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "httpMethod": "PUT",
+ "id": "dfareporting.reports.update",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ },
+ "resources": {
+ "compatibleFields": {
+ "methods": {
+ "query": {
+ "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/compatiblefields/query",
+ "httpMethod": "POST",
+ "id": "dfareporting.reports.compatibleFields.query",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/compatiblefields/query",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "CompatibleFields"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ },
+ "files": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.get",
+ "parameterOrder": [
+ "profileId",
+ "reportId",
+ "fileId"
+ ],
+ "parameters": {
+ "fileId": {
+ "description": "The ID of the report file.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
+ "response": {
+ "$ref": "File"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ],
+ "supportsMediaDownload": true
+ },
+ "list": {
+ "description": "Lists files for a report.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/files",
+ "httpMethod": "GET",
+ "id": "dfareporting.reports.files.list",
+ "parameterOrder": [
+ "profileId",
+ "reportId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "default": "10",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The Campaign Manager 360 user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the parent report.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "LAST_MODIFIED_TIME",
+ "description": "The field by which to sort the list.",
+ "enum": [
+ "ID",
+ "LAST_MODIFIED_TIME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "DESCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/reports/{reportId}/files",
+ "response": {
+ "$ref": "FileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfareporting"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets one site by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sites/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sites/{id}",
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new site.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "httpMethod": "POST",
+ "id": "dfareporting.sites.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "httpMethod": "GET",
+ "id": "dfareporting.sites.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "acceptsInStreamVideoPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsInterstitialPlacements": {
+ "description": "This search filter is no longer supported and will have no effect on the results returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "acceptsPublisherPaidPlacements": {
+ "description": "Select only sites that accept publisher paid placements.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "adWordsSite": {
+ "description": "Select only AdWords sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "approved": {
+ "description": "Select only approved sites.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "campaignIds": {
+ "description": "Select only sites with these campaign IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "directorySiteIds": {
+ "description": "Select only sites with these directory site IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only sites with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only sites with this subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "unmappedSite": {
+ "description": "Select only sites that have not been mapped to a directory site.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "response": {
+ "$ref": "SitesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing site. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.sites.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Site ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing site.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "httpMethod": "PUT",
+ "id": "dfareporting.sites.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sites",
+ "request": {
+ "$ref": "Site"
+ },
+ "response": {
+ "$ref": "Site"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "sizes": {
+ "methods": {
+ "get": {
+ "description": "Gets one size by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sizes/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Size ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sizes/{id}",
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new size.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sizes",
+ "httpMethod": "POST",
+ "id": "dfareporting.sizes.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sizes",
+ "request": {
+ "$ref": "Size"
+ },
+ "response": {
+ "$ref": "Size"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/sizes",
+ "httpMethod": "GET",
+ "id": "dfareporting.sizes.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "height": {
+ "description": "Select only sizes with this height.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "iabStandard": {
+ "description": "Select only IAB standard sizes.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only sizes with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "width": {
+ "description": "Select only sizes with this width.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "32767",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/sizes",
+ "response": {
+ "$ref": "SizesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "subaccounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one subaccount by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts/{id}",
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new subaccount.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "httpMethod": "POST",
+ "id": "dfareporting.subaccounts.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "httpMethod": "GET",
+ "id": "dfareporting.subaccounts.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only subaccounts with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "response": {
+ "$ref": "SubaccountsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing subaccount. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.subaccounts.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Subaccount ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing subaccount.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "httpMethod": "PUT",
+ "id": "dfareporting.subaccounts.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/subaccounts",
+ "request": {
+ "$ref": "Subaccount"
+ },
+ "response": {
+ "$ref": "Subaccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetableRemarketingLists": {
+ "methods": {
+ "get": {
+ "description": "Gets one remarketing list by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Remarketing list ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetableRemarketingLists/{id}",
+ "response": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetableRemarketingLists",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetableRemarketingLists.list",
+ "parameterOrder": [
+ "profileId",
+ "advertiserId"
+ ],
+ "parameters": {
+ "active": {
+ "description": "Select only active or only inactive targetable remarketing lists.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Select only targetable remarketing lists targetable by these advertisers.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetableRemarketingLists",
+ "response": {
+ "$ref": "TargetableRemarketingListsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "targetingTemplates": {
+ "methods": {
+ "get": {
+ "description": "Gets one targeting template by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Targeting template ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates/{id}",
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new targeting template.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "POST",
+ "id": "dfareporting.targetingTemplates.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "GET",
+ "id": "dfareporting.targetingTemplates.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "advertiserId": {
+ "description": "Select only targeting templates with this advertiser ID.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Select only targeting templates with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "response": {
+ "$ref": "TargetingTemplatesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing targeting template. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.targetingTemplates.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "TargetingTemplate ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing targeting template.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "httpMethod": "PUT",
+ "id": "dfareporting.targetingTemplates.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/targetingTemplates",
+ "request": {
+ "$ref": "TargetingTemplate"
+ },
+ "response": {
+ "$ref": "TargetingTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userProfiles": {
+ "methods": {
+ "get": {
+ "description": "Gets one user profile by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.get",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "The user profile ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves list of user profiles for a user.",
+ "flatPath": "dfareporting/v3.5/userprofiles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userProfiles.list",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "dfareporting/v3.5/userprofiles",
+ "response": {
+ "$ref": "UserProfileList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions",
+ "https://www.googleapis.com/auth/dfareporting",
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissionGroups": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission group by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission group ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissionGroups/{id}",
+ "response": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of all supported user role permission groups.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissionGroups",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissionGroups.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissionGroups",
+ "response": {
+ "$ref": "UserRolePermissionGroupsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRolePermissions": {
+ "methods": {
+ "get": {
+ "description": "Gets one user role permission by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissions/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role permission ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissions/{id}",
+ "response": {
+ "$ref": "UserRolePermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Gets a list of user role permissions, possibly filtered.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissions",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRolePermissions.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "ids": {
+ "description": "Select only user role permissions with these IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRolePermissions",
+ "response": {
+ "$ref": "UserRolePermissionsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "userRoles": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing user role.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "DELETE",
+ "id": "dfareporting.userRoles.delete",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles/{id}",
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "get": {
+ "description": "Gets one user role by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "User role ID.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles/{id}",
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new user role.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "httpMethod": "POST",
+ "id": "dfareporting.userRoles.insert",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "httpMethod": "GET",
+ "id": "dfareporting.userRoles.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "accountUserRoleOnly": {
+ "description": "Select only account level user roles not associated with any specific subaccount.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ids": {
+ "description": "Select only user roles with the specified IDs.",
+ "format": "int64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "1000",
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Value of the nextPageToken from the previous result page.",
+ "location": "query",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
+ "location": "query",
+ "type": "string"
+ },
+ "sortField": {
+ "default": "ID",
+ "description": "Field by which to sort the list.",
+ "enum": [
+ "ID",
+ "NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "default": "ASCENDING",
+ "description": "Order of sorted results.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Select only user roles that belong to this subaccount.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "response": {
+ "$ref": "UserRolesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing user role. This method supports patch semantics.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "httpMethod": "PATCH",
+ "id": "dfareporting.userRoles.patch",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "UserRole ID.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing user role.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "httpMethod": "PUT",
+ "id": "dfareporting.userRoles.update",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/userRoles",
+ "request": {
+ "$ref": "UserRole"
+ },
+ "response": {
+ "$ref": "UserRole"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ },
+ "videoFormats": {
+ "methods": {
+ "get": {
+ "description": "Gets one video format by ID.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/videoFormats/{id}",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.get",
+ "parameterOrder": [
+ "profileId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Video format ID.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/videoFormats/{id}",
+ "response": {
+ "$ref": "VideoFormat"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "description": "Lists available video formats.",
+ "flatPath": "dfareporting/v3.5/userprofiles/{profileId}/videoFormats",
+ "httpMethod": "GET",
+ "id": "dfareporting.videoFormats.list",
+ "parameterOrder": [
+ "profileId"
+ ],
+ "parameters": {
+ "profileId": {
+ "description": "User profile ID associated with this request.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dfareporting/v3.5/userprofiles/{profileId}/videoFormats",
+ "response": {
+ "$ref": "VideoFormatsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210524",
+ "rootUrl": "https://dfareporting.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Contains properties of a Campaign Manager account.",
+ "id": "Account",
+ "properties": {
+ "accountPermissionIds": {
+ "description": "Account permissions assigned to this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "accountProfile": {
+ "description": "Profile for this account. This is a read-only field that can be left blank.",
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this account is active.",
+ "type": "boolean"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for this account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "activeViewOptOut": {
+ "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.",
+ "type": "boolean"
+ },
+ "availablePermissionIds": {
+ "description": "User role permissions available to the user roles of this account.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "countryId": {
+ "description": "ID of the country associated with this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyId": {
+ "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultCreativeSizeId": {
+ "description": "Default placement dimensions for this account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of this account.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this account. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "maximumImageSize": {
+ "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.",
+ "type": "boolean"
+ },
+ "reportsConfiguration": {
+ "$ref": "ReportsConfiguration",
+ "description": "Reporting configuration of this account."
+ },
+ "shareReportsWithTwitter": {
+ "description": "Share Path to Conversion reports with Twitter.",
+ "type": "boolean"
+ },
+ "teaserSizeLimit": {
+ "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountActiveAdSummary": {
+ "description": "Gets a summary of active ads in an account.",
+ "id": "AccountActiveAdSummary",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAds": {
+ "description": "Ads that have been activated for the account",
+ "format": "int64",
+ "type": "string"
+ },
+ "activeAdsLimitTier": {
+ "description": "Maximum number of active ads allowed for the account.",
+ "enum": [
+ "ACTIVE_ADS_TIER_40K",
+ "ACTIVE_ADS_TIER_75K",
+ "ACTIVE_ADS_TIER_100K",
+ "ACTIVE_ADS_TIER_200K",
+ "ACTIVE_ADS_TIER_300K",
+ "ACTIVE_ADS_TIER_500K",
+ "ACTIVE_ADS_TIER_750K",
+ "ACTIVE_ADS_TIER_1M"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "availableAds": {
+ "description": "Ads that can be activated for the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermission": {
+ "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
+ "id": "AccountPermission",
+ "properties": {
+ "accountProfiles": {
+ "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
+ "items": {
+ "enum": [
+ "ACCOUNT_PROFILE_BASIC",
+ "ACCOUNT_PROFILE_STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this account permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
+ "type": "string"
+ },
+ "level": {
+ "description": "Administrative level required to enable this account permission.",
+ "enum": [
+ "USER",
+ "ADMINISTRATOR"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "Permission group of this account permission.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroup": {
+ "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
+ "id": "AccountPermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this account permission group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionGroupsListResponse": {
+ "description": "Account Permission Group List Response",
+ "id": "AccountPermissionGroupsListResponse",
+ "properties": {
+ "accountPermissionGroups": {
+ "description": "Account permission group collection.",
+ "items": {
+ "$ref": "AccountPermissionGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPermissionsListResponse": {
+ "description": "Account Permission List Response",
+ "id": "AccountPermissionsListResponse",
+ "properties": {
+ "accountPermissions": {
+ "description": "Account permission collection.",
+ "items": {
+ "$ref": "AccountPermission"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfile": {
+ "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
+ "id": "AccountUserProfile",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.",
+ "type": "boolean"
+ },
+ "advertiserFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which advertisers are visible to the user profile."
+ },
+ "campaignFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which campaigns are visible to the user profile."
+ },
+ "comments": {
+ "description": "Comments for this user profile.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the user profile. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".",
+ "type": "string"
+ },
+ "siteFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which sites are visible to the user profile."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerType": {
+ "description": "Trafficker type of this user profile. This is a read-only field.",
+ "enum": [
+ "INTERNAL_NON_TRAFFICKER",
+ "INTERNAL_TRAFFICKER",
+ "EXTERNAL_TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userAccessType": {
+ "description": "User type of the user profile. This is a read-only field that can be left blank.",
+ "enum": [
+ "NORMAL_USER",
+ "SUPER_USER",
+ "INTERNAL_ADMINISTRATOR",
+ "READ_ONLY_SUPER_USER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "userRoleFilter": {
+ "$ref": "ObjectFilter",
+ "description": "Filter that describes which user roles are visible to the user profile."
+ },
+ "userRoleId": {
+ "description": "User role ID of the user profile. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountUserProfilesListResponse": {
+ "description": "Account User Profile List Response",
+ "id": "AccountUserProfilesListResponse",
+ "properties": {
+ "accountUserProfiles": {
+ "description": "Account user profile collection.",
+ "items": {
+ "$ref": "AccountUserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountsListResponse": {
+ "description": "Account List Response",
+ "id": "AccountsListResponse",
+ "properties": {
+ "accounts": {
+ "description": "Account collection.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Activities": {
+ "description": "Represents an activity group.",
+ "id": "Activities",
+ "properties": {
+ "filters": {
+ "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#activities.",
+ "type": "string"
+ },
+ "metricNames": {
+ "description": "List of names of floodlight activity metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Ad": {
+ "description": "Contains properties of a Campaign Manager ad.",
+ "id": "Ad",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this ad is active. When true, archived must be false.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this ad is archived. When true, active must be false.",
+ "type": "boolean"
+ },
+ "audienceSegmentId": {
+ "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this ad. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
+ },
+ "comments": {
+ "description": "Comments for this ad.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this ad. This is a read-only field."
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeRotation": {
+ "$ref": "CreativeRotation",
+ "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Default click-through event tag properties for this ad."
+ },
+ "deliverySchedule": {
+ "$ref": "DeliverySchedule",
+ "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
+ },
+ "dynamicClickTracker": {
+ "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Event tag overrides for this ad.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "id": {
+ "description": "ID of this ad. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this ad. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this ad. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementAssignments": {
+ "description": "Placement assignments for this ad.",
+ "items": {
+ "$ref": "PlacementAssignment"
+ },
+ "type": "array"
+ },
+ "remarketingListExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
+ },
+ "sslCompliant": {
+ "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
+ },
+ "type": {
+ "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
+ "enum": [
+ "AD_SERVING_STANDARD_AD",
+ "AD_SERVING_DEFAULT_AD",
+ "AD_SERVING_CLICK_TRACKER",
+ "AD_SERVING_TRACKING",
+ "AD_SERVING_BRAND_SAFE_AD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdBlockingConfiguration": {
+ "description": "Campaign ad blocking settings.",
+ "id": "AdBlockingConfiguration",
+ "properties": {
+ "enabled": {
+ "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdSlot": {
+ "description": "Ad Slot",
+ "id": "AdSlot",
+ "properties": {
+ "comment": {
+ "description": "Comment for this ad slot.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "height": {
+ "description": "Height of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "linkedPlacementId": {
+ "description": "ID of the placement from an external platform that is linked to this ad slot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this ad slot.",
+ "type": "string"
+ },
+ "paymentSourceType": {
+ "description": "Payment source type of this ad slot.",
+ "enum": [
+ "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
+ "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "primary": {
+ "description": "Primary ad slot of a roadblock inventory item.",
+ "type": "boolean"
+ },
+ "width": {
+ "description": "Width of this ad slot.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdsListResponse": {
+ "description": "Ad List Response",
+ "id": "AdsListResponse",
+ "properties": {
+ "ads": {
+ "description": "Ad collection.",
+ "items": {
+ "$ref": "Ad"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Advertiser": {
+ "description": "Contains properties of a Campaign Manager advertiser.",
+ "id": "Advertiser",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserGroupId": {
+ "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickThroughUrlSuffix": {
+ "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
+ "type": "string"
+ },
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultEmail": {
+ "description": "Default email address used in sender field for tag emails.",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this advertiser. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
+ "type": "string"
+ },
+ "measurementPartnerLink": {
+ "$ref": "MeasurementPartnerAdvertiserLink",
+ "description": "Measurement partner advertiser link for tag wrapping."
+ },
+ "name": {
+ "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
+ "type": "string"
+ },
+ "originalFloodlightConfigurationId": {
+ "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this advertiser.",
+ "enum": [
+ "APPROVED",
+ "ON_HOLD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "suspended": {
+ "description": "Suspension status of this advertiser.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroup": {
+ "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
+ "id": "AdvertiserGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserGroupsListResponse": {
+ "description": "Advertiser Group List Response",
+ "id": "AdvertiserGroupsListResponse",
+ "properties": {
+ "advertiserGroups": {
+ "description": "Advertiser group collection.",
+ "items": {
+ "$ref": "AdvertiserGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertiserLandingPagesListResponse": {
+ "description": "Landing Page List Response",
+ "id": "AdvertiserLandingPagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
+ "type": "string"
+ },
+ "landingPages": {
+ "description": "Landing page collection",
+ "items": {
+ "$ref": "LandingPage"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdvertisersListResponse": {
+ "description": "Advertiser List Response",
+ "id": "AdvertisersListResponse",
+ "properties": {
+ "advertisers": {
+ "description": "Advertiser collection.",
+ "items": {
+ "$ref": "Advertiser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegment": {
+ "description": "Audience Segment.",
+ "id": "AudienceSegment",
+ "properties": {
+ "allocation": {
+ "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this audience segment. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AudienceSegmentGroup": {
+ "description": "Audience Segment Group.",
+ "id": "AudienceSegmentGroup",
+ "properties": {
+ "audienceSegments": {
+ "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
+ "items": {
+ "$ref": "AudienceSegment"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Browser": {
+ "description": "Contains information about a browser that can be targeted by ads.",
+ "id": "Browser",
+ "properties": {
+ "browserVersionId": {
+ "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this browser. This is the ID used when generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BrowsersListResponse": {
+ "description": "Browser List Response",
+ "id": "BrowsersListResponse",
+ "properties": {
+ "browsers": {
+ "description": "Browser collection.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Campaign": {
+ "description": "Contains properties of a Campaign Manager campaign.",
+ "id": "Campaign",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingConfiguration": {
+ "$ref": "AdBlockingConfiguration",
+ "description": "Ad blocking settings for this campaign."
+ },
+ "additionalCreativeOptimizationConfigurations": {
+ "description": "Additional creative optimization configurations for the campaign.",
+ "items": {
+ "$ref": "CreativeOptimizationConfiguration"
+ },
+ "type": "array"
+ },
+ "advertiserGroupId": {
+ "description": "Advertiser group ID of the associated advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this campaign has been archived.",
+ "type": "boolean"
+ },
+ "audienceSegmentGroups": {
+ "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
+ "items": {
+ "$ref": "AudienceSegmentGroup"
+ },
+ "type": "array"
+ },
+ "billingInvoiceCode": {
+ "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.",
+ "type": "string"
+ },
+ "clickThroughUrlSuffixProperties": {
+ "$ref": "ClickThroughUrlSuffixProperties",
+ "description": "Click-through URL suffix override properties for this campaign."
+ },
+ "comment": {
+ "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this campaign. This is a read-only field."
+ },
+ "creativeGroupIds": {
+ "description": "List of creative group IDs that are assigned to the campaign.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfiguration": {
+ "$ref": "CreativeOptimizationConfiguration",
+ "description": "Creative optimization configuration for the campaign."
+ },
+ "defaultClickThroughEventTagProperties": {
+ "$ref": "DefaultClickThroughEventTagProperties",
+ "description": "Click-through event tag ID override properties for this campaign."
+ },
+ "defaultLandingPageId": {
+ "description": "The default landing page ID for this campaign.",
+ "format": "int64",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "eventTagOverrides": {
+ "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
+ "items": {
+ "$ref": "EventTagOverride"
+ },
+ "type": "array"
+ },
+ "externalId": {
+ "description": "External ID for this campaign.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this campaign. This is a read-only auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this campaign. This is a read-only field."
+ },
+ "measurementPartnerLink": {
+ "$ref": "MeasurementPartnerCampaignLink",
+ "description": "Measurement partner campaign link for tag wrapping."
+ },
+ "name": {
+ "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.",
+ "type": "string"
+ },
+ "nielsenOcrEnabled": {
+ "description": "Whether Nielsen reports are enabled for this campaign.",
+ "type": "boolean"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traffickerEmails": {
+ "description": "Campaign trafficker contact emails.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociation": {
+ "description": "Identifies a creative which has been associated with a given campaign.",
+ "id": "CampaignCreativeAssociation",
+ "properties": {
+ "creativeId": {
+ "description": "ID of the creative associated with the campaign. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCreativeAssociationsListResponse": {
+ "description": "Campaign Creative Association List Response",
+ "id": "CampaignCreativeAssociationsListResponse",
+ "properties": {
+ "campaignCreativeAssociations": {
+ "description": "Campaign creative association collection",
+ "items": {
+ "$ref": "CampaignCreativeAssociation"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignsListResponse": {
+ "description": "Campaign List Response",
+ "id": "CampaignsListResponse",
+ "properties": {
+ "campaigns": {
+ "description": "Campaign collection.",
+ "items": {
+ "$ref": "Campaign"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLog": {
+ "description": "Describes a change that a user has made to a resource.",
+ "id": "ChangeLog",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "action": {
+ "description": "Action which caused the change.",
+ "type": "string"
+ },
+ "changeTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "fieldName": {
+ "description": "Field name of the object which changed.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this change log.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
+ "type": "string"
+ },
+ "newValue": {
+ "description": "New value of the object field.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Object type of the change log.",
+ "type": "string"
+ },
+ "oldValue": {
+ "description": "Old value of the object field.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of the modified object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transactionId": {
+ "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileId": {
+ "description": "ID of the user who modified the object.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userProfileName": {
+ "description": "User profile name of the user who modified the object.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChangeLogsListResponse": {
+ "description": "Change Log List Response",
+ "id": "ChangeLogsListResponse",
+ "properties": {
+ "changeLogs": {
+ "description": "Change log collection.",
+ "items": {
+ "$ref": "ChangeLog"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChannelGrouping": {
+ "description": "Represents a DfaReporting channel grouping.",
+ "id": "ChannelGrouping",
+ "properties": {
+ "fallbackName": {
+ "description": "ChannelGrouping fallback name.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#channelGrouping.",
+ "type": "string"
+ },
+ "name": {
+ "description": "ChannelGrouping name.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "The rules contained within this channel grouping.",
+ "items": {
+ "$ref": "ChannelGroupingRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ChannelGroupingRule": {
+ "description": "Represents a DfaReporting channel grouping rule.",
+ "id": "ChannelGroupingRule",
+ "properties": {
+ "disjunctiveMatchStatements": {
+ "description": "The disjunctive match statements contained within this rule.",
+ "items": {
+ "$ref": "DisjunctiveMatchStatement"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#channelGroupingRule.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Rule name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CitiesListResponse": {
+ "description": "City List Response",
+ "id": "CitiesListResponse",
+ "properties": {
+ "cities": {
+ "description": "City collection.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "City": {
+ "description": "Contains information about a city that can be targeted by ads.",
+ "id": "City",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this city belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro region code of the metro region (DMA) to which this city belongs.",
+ "type": "string"
+ },
+ "metroDmaId": {
+ "description": "ID of the metro region (DMA) to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this city.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code of the region to which this city belongs.",
+ "type": "string"
+ },
+ "regionDartId": {
+ "description": "DART ID of the region to which this city belongs.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickTag": {
+ "description": "Creative Click Tag.",
+ "id": "ClickTag",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Parameter value for the specified click tag. This field contains a click-through url."
+ },
+ "eventName": {
+ "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "ClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "defaultLandingPage": {
+ "description": "Whether the campaign default landing page is used.",
+ "type": "boolean"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClickThroughUrlSuffixProperties": {
+ "description": "Click Through URL Suffix settings.",
+ "id": "ClickThroughUrlSuffixProperties",
+ "properties": {
+ "clickThroughUrlSuffix": {
+ "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
+ "type": "string"
+ },
+ "overrideInheritedSuffix": {
+ "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionClickThroughOverride": {
+ "description": "Companion Click-through override.",
+ "id": "CompanionClickThroughOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this companion click-through override."
+ },
+ "creativeId": {
+ "description": "ID of the creative for this companion click-through override.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompanionSetting": {
+ "description": "Companion Settings",
+ "id": "CompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this placement.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CompatibleFields": {
+ "description": "Represents a response to the queryCompatibleFields method.",
+ "id": "CompatibleFields",
+ "properties": {
+ "crossDimensionReachReportCompatibleFields": {
+ "$ref": "CrossDimensionReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
+ },
+ "floodlightReportCompatibleFields": {
+ "$ref": "FloodlightReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
+ "type": "string"
+ },
+ "pathAttributionReportCompatibleFields": {
+ "$ref": "PathReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH_ATTRIBUTION\"."
+ },
+ "pathReportCompatibleFields": {
+ "$ref": "PathReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH\"."
+ },
+ "pathToConversionReportCompatibleFields": {
+ "$ref": "PathToConversionReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
+ },
+ "reachReportCompatibleFields": {
+ "$ref": "ReachReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
+ },
+ "reportCompatibleFields": {
+ "$ref": "ReportCompatibleFields",
+ "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionType": {
+ "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
+ "id": "ConnectionType",
+ "properties": {
+ "id": {
+ "description": "ID of this connection type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this connection type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConnectionTypesListResponse": {
+ "description": "Connection Type List Response",
+ "id": "ConnectionTypesListResponse",
+ "properties": {
+ "connectionTypes": {
+ "description": "Collection of connection types such as broadband and mobile.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategoriesListResponse": {
+ "description": "Content Category List Response",
+ "id": "ContentCategoriesListResponse",
+ "properties": {
+ "contentCategories": {
+ "description": "Content category collection.",
+ "items": {
+ "$ref": "ContentCategory"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContentCategory": {
+ "description": "Organizes placements according to the contents of their associated webpages.",
+ "id": "ContentCategory",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this content category. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this content category. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Conversion": {
+ "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
+ "id": "Conversion",
+ "properties": {
+ "childDirectedTreatment": {
+ "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
+ "type": "boolean"
+ },
+ "customVariables": {
+ "description": "Custom floodlight variables.",
+ "items": {
+ "$ref": "CustomFloodlightVariable"
+ },
+ "type": "array"
+ },
+ "dclid": {
+ "description": "The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
+ "type": "string"
+ },
+ "encryptedUserId": {
+ "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "encryptedUserIdCandidates": {
+ "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight Activity ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight Configuration ID of this conversion. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "gclid": {
+ "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
+ "type": "string"
+ },
+ "limitAdTracking": {
+ "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
+ "type": "boolean"
+ },
+ "matchId": {
+ "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "mobileDeviceId": {
+ "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.",
+ "type": "string"
+ },
+ "nonPersonalizedAd": {
+ "description": "Whether the conversion was for a non personalized ad.",
+ "type": "boolean"
+ },
+ "ordinal": {
+ "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity of the conversion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timestampMicros": {
+ "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "treatmentForUnderage": {
+ "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The value of the conversion.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionError": {
+ "description": "The error code and description for a conversion that failed to insert or update.",
+ "id": "ConversionError",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "INVALID_ARGUMENT",
+ "INTERNAL",
+ "PERMISSION_DENIED",
+ "NOT_FOUND"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
+ "type": "string"
+ },
+ "message": {
+ "description": "A description of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionStatus": {
+ "description": "The original conversion that was inserted or updated and whether there were any errors.",
+ "id": "ConversionStatus",
+ "properties": {
+ "conversion": {
+ "$ref": "Conversion",
+ "description": "The original conversion that was inserted or updated."
+ },
+ "errors": {
+ "description": "A list of errors related to this conversion.",
+ "items": {
+ "$ref": "ConversionError"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertRequest": {
+ "description": "Insert Conversions Request.",
+ "id": "ConversionsBatchInsertRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to insert.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchInsertResponse": {
+ "description": "Insert Conversions Response.",
+ "id": "ConversionsBatchInsertResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to insert.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateRequest": {
+ "description": "Update Conversions Request.",
+ "id": "ConversionsBatchUpdateRequest",
+ "properties": {
+ "conversions": {
+ "description": "The set of conversions to update.",
+ "items": {
+ "$ref": "Conversion"
+ },
+ "type": "array"
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConversionsBatchUpdateResponse": {
+ "description": "Update Conversions Response.",
+ "id": "ConversionsBatchUpdateResponse",
+ "properties": {
+ "hasFailures": {
+ "description": "Indicates that some or all conversions failed to update.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
+ "type": "string"
+ },
+ "status": {
+ "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.",
+ "items": {
+ "$ref": "ConversionStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CountriesListResponse": {
+ "description": "Country List Response",
+ "id": "CountriesListResponse",
+ "properties": {
+ "countries": {
+ "description": "Country collection.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Country": {
+ "description": "Contains information about a country that can be targeted by ads.",
+ "id": "Country",
+ "properties": {
+ "countryCode": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this country.",
+ "type": "string"
+ },
+ "sslEnabled": {
+ "description": "Whether ad serving supports secure servers in this country.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Creative": {
+ "description": "Contains properties of a Creative.",
+ "id": "Creative",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether the creative is active. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "adParameters": {
+ "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "type": "string"
+ },
+ "adTagKeys": {
+ "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "allowScriptAccess": {
+ "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "boolean"
+ },
+ "archived": {
+ "description": "Whether the creative is archived. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "artworkType": {
+ "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringSource": {
+ "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
+ "enum": [
+ "CREATIVE_AUTHORING_SOURCE_DCM",
+ "CREATIVE_AUTHORING_SOURCE_DBM",
+ "CREATIVE_AUTHORING_SOURCE_STUDIO",
+ "CREATIVE_AUTHORING_SOURCE_GWD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "authoringTool": {
+ "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "enum": [
+ "NINJA",
+ "SWIFFY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "autoAdvanceImages": {
+ "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
+ "type": "boolean"
+ },
+ "backgroundColor": {
+ "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
+ "type": "string"
+ },
+ "backupImageClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE."
+ },
+ "backupImageFeatures": {
+ "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "backupImageReportingLabel": {
+ "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "string"
+ },
+ "backupImageTargetWindow": {
+ "$ref": "TargetWindow",
+ "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "clickTags": {
+ "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "commercialId": {
+ "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.",
+ "type": "string"
+ },
+ "companionCreatives": {
+ "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibility": {
+ "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "convertFlashToHtml5": {
+ "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "counterCustomEvents": {
+ "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "creativeAssetSelection": {
+ "$ref": "CreativeAssetSelection",
+ "description": "Required if dynamicAssetSelection is true."
+ },
+ "creativeAssets": {
+ "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
+ "items": {
+ "$ref": "CreativeAsset"
+ },
+ "type": "array"
+ },
+ "creativeFieldAssignments": {
+ "description": "Creative field assignments for this creative. Applicable to all creative types.",
+ "items": {
+ "$ref": "CreativeFieldAssignment"
+ },
+ "type": "array"
+ },
+ "customKeyValues": {
+ "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dynamicAssetSelection": {
+ "description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.",
+ "type": "boolean"
+ },
+ "exitCustomEvents": {
+ "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "fsCommand": {
+ "$ref": "FsCommand",
+ "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
+ },
+ "htmlCode": {
+ "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
+ "type": "string"
+ },
+ "htmlCodeLocked": {
+ "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
+ },
+ "latestTraffickedCreativeId": {
+ "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "mediaDescription": {
+ "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
+ "type": "string"
+ },
+ "mediaDuration": {
+ "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "name": {
+ "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.",
+ "type": "string"
+ },
+ "obaIcon": {
+ "$ref": "ObaIcon",
+ "description": "Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "overrideCss": {
+ "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "redirectUrl": {
+ "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT",
+ "type": "string"
+ },
+ "renderingId": {
+ "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "renderingIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
+ },
+ "requiredFlashPluginVersion": {
+ "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "type": "string"
+ },
+ "requiredFlashVersion": {
+ "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO."
+ },
+ "skippable": {
+ "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "sslOverride": {
+ "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
+ "type": "boolean"
+ },
+ "studioAdvertiserId": {
+ "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioCreativeId": {
+ "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "studioTraffickedCreativeId": {
+ "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
+ "format": "int64",
+ "type": "string"
+ },
+ "thirdPartyBackupImageImpressionsUrl": {
+ "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyRichMediaImpressionsUrl": {
+ "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "string"
+ },
+ "thirdPartyUrls": {
+ "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
+ "items": {
+ "$ref": "ThirdPartyTrackingUrl"
+ },
+ "type": "array"
+ },
+ "timerCustomEvents": {
+ "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "totalFileSize": {
+ "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.",
+ "enum": [
+ "IMAGE",
+ "DISPLAY_REDIRECT",
+ "CUSTOM_DISPLAY",
+ "INTERNAL_REDIRECT",
+ "CUSTOM_DISPLAY_INTERSTITIAL",
+ "INTERSTITIAL_INTERNAL_REDIRECT",
+ "TRACKING_TEXT",
+ "RICH_MEDIA_DISPLAY_BANNER",
+ "RICH_MEDIA_INPAGE_FLOATING",
+ "RICH_MEDIA_IM_EXPAND",
+ "RICH_MEDIA_DISPLAY_EXPANDING",
+ "RICH_MEDIA_DISPLAY_INTERSTITIAL",
+ "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
+ "RICH_MEDIA_MOBILE_IN_APP",
+ "FLASH_INPAGE",
+ "INSTREAM_VIDEO",
+ "VPAID_LINEAR_VIDEO",
+ "VPAID_NON_LINEAR_VIDEO",
+ "INSTREAM_VIDEO_REDIRECT",
+ "RICH_MEDIA_PEEL_DOWN",
+ "HTML5_BANNER",
+ "DISPLAY",
+ "DISPLAY_IMAGE_GALLERY",
+ "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
+ "INSTREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "universalAdId": {
+ "$ref": "UniversalAdId",
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
+ },
+ "version": {
+ "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAsset": {
+ "description": "Creative Asset.",
+ "id": "CreativeAsset",
+ "properties": {
+ "actionScript3": {
+ "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "type": "boolean"
+ },
+ "active": {
+ "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "alignment": {
+ "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .",
+ "enum": [
+ "ALIGNMENT_TOP",
+ "ALIGNMENT_RIGHT",
+ "ALIGNMENT_BOTTOM",
+ "ALIGNMENT_LEFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
+ },
+ "audioBitRate": {
+ "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "audioSampleRate": {
+ "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "backupImageExit": {
+ "$ref": "CreativeCustomEvent",
+ "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "bitRate": {
+ "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "childAssetType": {
+ "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
+ "enum": [
+ "CHILD_ASSET_TYPE_FLASH",
+ "CHILD_ASSET_TYPE_VIDEO",
+ "CHILD_ASSET_TYPE_IMAGE",
+ "CHILD_ASSET_TYPE_DATA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "collapsedSize": {
+ "$ref": "Size",
+ "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "companionCreativeIds": {
+ "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "customStartTimeValue": {
+ "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "displayType": {
+ "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DISPLAY_TYPE_INPAGE",
+ "ASSET_DISPLAY_TYPE_FLOATING",
+ "ASSET_DISPLAY_TYPE_OVERLAY",
+ "ASSET_DISPLAY_TYPE_EXPANDING",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
+ "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
+ "ASSET_DISPLAY_TYPE_PEEL_DOWN",
+ "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
+ "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
+ "ASSET_DISPLAY_TYPE_BACKDROP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "duration": {
+ "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "durationType": {
+ "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_DURATION_TYPE_AUTO",
+ "ASSET_DURATION_TYPE_NONE",
+ "ASSET_DURATION_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "expandedDimension": {
+ "$ref": "Size",
+ "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
+ },
+ "fileSize": {
+ "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "flashVersion": {
+ "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frameRate": {
+ "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "hideFlashObjects": {
+ "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "hideSelectionBoxes": {
+ "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "horizontallyLocked": {
+ "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
+ },
+ "mediaDuration": {
+ "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "format": "float",
+ "type": "number"
+ },
+ "mimeType": {
+ "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
+ },
+ "orientation": {
+ "description": "Orientation of video asset. This is a read-only, auto-generated field.",
+ "enum": [
+ "LANDSCAPE",
+ "PORTRAIT",
+ "SQUARE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "originalBackup": {
+ "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "politeLoad": {
+ "description": "Whether this asset is used as a polite load asset.",
+ "type": "boolean"
+ },
+ "position": {
+ "$ref": "OffsetPosition",
+ "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
+ },
+ "positionLeftUnit": {
+ "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "positionTopUnit": {
+ "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "OFFSET_UNIT_PIXEL",
+ "OFFSET_UNIT_PERCENT",
+ "OFFSET_UNIT_PIXEL_FROM_CENTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "progressiveServingUrl": {
+ "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "pushdown": {
+ "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
+ "type": "boolean"
+ },
+ "pushdownDuration": {
+ "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
+ "format": "float",
+ "type": "number"
+ },
+ "role": {
+ "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
+ "enum": [
+ "PRIMARY",
+ "BACKUP_IMAGE",
+ "ADDITIONAL_IMAGE",
+ "ADDITIONAL_FLASH",
+ "PARENT_VIDEO",
+ "TRANSCODED_VIDEO",
+ "OTHER",
+ "ALTERNATE_VIDEO",
+ "PARENT_AUDIO",
+ "TRANSCODED_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
+ },
+ "sslCompliant": {
+ "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
+ "type": "boolean"
+ },
+ "startTimeType": {
+ "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
+ "enum": [
+ "ASSET_START_TIME_TYPE_NONE",
+ "ASSET_START_TIME_TYPE_CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "streamingServingUrl": {
+ "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
+ "type": "string"
+ },
+ "transparency": {
+ "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.",
+ "type": "boolean"
+ },
+ "verticallyLocked": {
+ "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
+ "type": "boolean"
+ },
+ "windowMode": {
+ "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
+ "enum": [
+ "OPAQUE",
+ "WINDOW",
+ "TRANSPARENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "zIndex": {
+ "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "zipFilename": {
+ "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ },
+ "zipFilesize": {
+ "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetId": {
+ "description": "Creative Asset ID.",
+ "id": "CreativeAssetId",
+ "properties": {
+ "name": {
+ "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
+ "enum": [
+ "IMAGE",
+ "FLASH",
+ "VIDEO",
+ "HTML",
+ "HTML_IMAGE",
+ "AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetMetadata": {
+ "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
+ "id": "CreativeAssetMetadata",
+ "properties": {
+ "assetIdentifier": {
+ "$ref": "CreativeAssetId",
+ "description": "ID of the creative asset. This is a required field."
+ },
+ "clickTags": {
+ "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
+ "items": {
+ "$ref": "ClickTag"
+ },
+ "type": "array"
+ },
+ "counterCustomEvents": {
+ "description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "detectedFeatures": {
+ "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
+ "items": {
+ "enum": [
+ "CSS_FONT_FACE",
+ "CSS_BACKGROUND_SIZE",
+ "CSS_BORDER_IMAGE",
+ "CSS_BORDER_RADIUS",
+ "CSS_BOX_SHADOW",
+ "CSS_FLEX_BOX",
+ "CSS_HSLA",
+ "CSS_MULTIPLE_BGS",
+ "CSS_OPACITY",
+ "CSS_RGBA",
+ "CSS_TEXT_SHADOW",
+ "CSS_ANIMATIONS",
+ "CSS_COLUMNS",
+ "CSS_GENERATED_CONTENT",
+ "CSS_GRADIENTS",
+ "CSS_REFLECTIONS",
+ "CSS_TRANSFORMS",
+ "CSS_TRANSFORMS3D",
+ "CSS_TRANSITIONS",
+ "APPLICATION_CACHE",
+ "CANVAS",
+ "CANVAS_TEXT",
+ "DRAG_AND_DROP",
+ "HASH_CHANGE",
+ "HISTORY",
+ "AUDIO",
+ "VIDEO",
+ "INDEXED_DB",
+ "INPUT_ATTR_AUTOCOMPLETE",
+ "INPUT_ATTR_AUTOFOCUS",
+ "INPUT_ATTR_LIST",
+ "INPUT_ATTR_PLACEHOLDER",
+ "INPUT_ATTR_MAX",
+ "INPUT_ATTR_MIN",
+ "INPUT_ATTR_MULTIPLE",
+ "INPUT_ATTR_PATTERN",
+ "INPUT_ATTR_REQUIRED",
+ "INPUT_ATTR_STEP",
+ "INPUT_TYPE_SEARCH",
+ "INPUT_TYPE_TEL",
+ "INPUT_TYPE_URL",
+ "INPUT_TYPE_EMAIL",
+ "INPUT_TYPE_DATETIME",
+ "INPUT_TYPE_DATE",
+ "INPUT_TYPE_MONTH",
+ "INPUT_TYPE_WEEK",
+ "INPUT_TYPE_TIME",
+ "INPUT_TYPE_DATETIME_LOCAL",
+ "INPUT_TYPE_NUMBER",
+ "INPUT_TYPE_RANGE",
+ "INPUT_TYPE_COLOR",
+ "LOCAL_STORAGE",
+ "POST_MESSAGE",
+ "SESSION_STORAGE",
+ "WEB_SOCKETS",
+ "WEB_SQL_DATABASE",
+ "WEB_WORKERS",
+ "GEO_LOCATION",
+ "INLINE_SVG",
+ "SMIL",
+ "SVG_HREF",
+ "SVG_CLIP_PATHS",
+ "TOUCH",
+ "WEBGL",
+ "SVG_FILTERS",
+ "SVG_FE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "exitCustomEvents": {
+ "description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
+ "type": "string"
+ },
+ "richMedia": {
+ "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.",
+ "type": "boolean"
+ },
+ "timerCustomEvents": {
+ "description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
+ "items": {
+ "$ref": "CreativeCustomEvent"
+ },
+ "type": "array"
+ },
+ "warnedValidationRules": {
+ "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
+ "items": {
+ "enum": [
+ "CLICK_TAG_NON_TOP_LEVEL",
+ "CLICK_TAG_MISSING",
+ "CLICK_TAG_MORE_THAN_ONE",
+ "CLICK_TAG_INVALID",
+ "ORPHANED_ASSET",
+ "PRIMARY_HTML_MISSING",
+ "EXTERNAL_FILE_REFERENCED",
+ "MRAID_REFERENCED",
+ "ADMOB_REFERENCED",
+ "FILE_TYPE_INVALID",
+ "ZIP_INVALID",
+ "LINKED_FILE_NOT_FOUND",
+ "MAX_FLASH_VERSION_11",
+ "NOT_SSL_COMPLIANT",
+ "FILE_DETAIL_EMPTY",
+ "ASSET_INVALID",
+ "GWD_PROPERTIES_INVALID",
+ "ENABLER_UNSUPPORTED_METHOD_DCM",
+ "ASSET_FORMAT_UNSUPPORTED_DCM",
+ "COMPONENT_UNSUPPORTED_DCM",
+ "HTML5_FEATURE_UNSUPPORTED",
+ "CLICK_TAG_IN_GWD",
+ "CLICK_TAG_HARD_CODED",
+ "SVG_INVALID",
+ "CLICK_TAG_IN_RICH_MEDIA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssetSelection": {
+ "description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "CreativeAssetSelection",
+ "properties": {
+ "defaultAssetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rules": {
+ "description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeAssignment": {
+ "description": "Creative Assignment.",
+ "id": "CreativeAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "applyEventTags": {
+ "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
+ "type": "boolean"
+ },
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of the creative assignment."
+ },
+ "companionCreativeOverrides": {
+ "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
+ "items": {
+ "$ref": "CompanionClickThroughOverride"
+ },
+ "type": "array"
+ },
+ "creativeGroupAssignments": {
+ "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
+ "items": {
+ "$ref": "CreativeGroupAssignment"
+ },
+ "type": "array"
+ },
+ "creativeId": {
+ "description": "ID of the creative to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "richMediaExitOverrides": {
+ "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
+ "items": {
+ "$ref": "RichMediaExitOverride"
+ },
+ "type": "array"
+ },
+ "sequence": {
+ "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sslCompliant": {
+ "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "weight": {
+ "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeClickThroughUrl": {
+ "description": "Click-through URL",
+ "id": "CreativeClickThroughUrl",
+ "properties": {
+ "computedClickThroughUrl": {
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
+ "type": "string"
+ },
+ "customClickThroughUrl": {
+ "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
+ "type": "string"
+ },
+ "landingPageId": {
+ "description": "ID of the landing page for the click-through URL.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeCustomEvent": {
+ "description": "Creative Custom Event.",
+ "id": "CreativeCustomEvent",
+ "properties": {
+ "advertiserCustomEventId": {
+ "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserCustomEventName": {
+ "description": "User-entered name for the event.",
+ "type": "string"
+ },
+ "advertiserCustomEventType": {
+ "description": "Type of the event. This is a read-only field.",
+ "enum": [
+ "ADVERTISER_EVENT_TIMER",
+ "ADVERTISER_EVENT_EXIT",
+ "ADVERTISER_EVENT_COUNTER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "artworkLabel": {
+ "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
+ "type": "string"
+ },
+ "artworkType": {
+ "description": "Artwork type used by the creative.This is a read-only field.",
+ "enum": [
+ "ARTWORK_TYPE_FLASH",
+ "ARTWORK_TYPE_HTML5",
+ "ARTWORK_TYPE_MIXED",
+ "ARTWORK_TYPE_IMAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "exitClickThroughUrl": {
+ "$ref": "CreativeClickThroughUrl",
+ "description": "Exit click-through URL for the event. This field is used only for exit events."
+ },
+ "id": {
+ "description": "ID of this event. This is a required field and should not be modified after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "popupWindowProperties": {
+ "$ref": "PopupWindowProperties",
+ "description": "Properties for rich media popup windows. This field is used only for exit events."
+ },
+ "targetType": {
+ "description": "Target type used by the event.",
+ "enum": [
+ "TARGET_BLANK",
+ "TARGET_TOP",
+ "TARGET_SELF",
+ "TARGET_PARENT",
+ "TARGET_POPUP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "videoReportingId": {
+ "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeField": {
+ "description": "Contains properties of a creative field.",
+ "id": "CreativeField",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative field. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this creative field. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldAssignment": {
+ "description": "Creative Field Assignment.",
+ "id": "CreativeFieldAssignment",
+ "properties": {
+ "creativeFieldId": {
+ "description": "ID of the creative field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeFieldValueId": {
+ "description": "ID of the creative field value.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValue": {
+ "description": "Contains properties of a creative field value.",
+ "id": "CreativeFieldValue",
+ "properties": {
+ "id": {
+ "description": "ID of this creative field value. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldValuesListResponse": {
+ "description": "Creative Field Value List Response",
+ "id": "CreativeFieldValuesListResponse",
+ "properties": {
+ "creativeFieldValues": {
+ "description": "Creative field value collection.",
+ "items": {
+ "$ref": "CreativeFieldValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeFieldsListResponse": {
+ "description": "Creative Field List Response",
+ "id": "CreativeFieldsListResponse",
+ "properties": {
+ "creativeFields": {
+ "description": "Creative field collection.",
+ "items": {
+ "$ref": "CreativeField"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroup": {
+ "description": "Contains properties of a creative group.",
+ "id": "CreativeGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this creative group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "groupNumber": {
+ "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "ID of this creative group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupAssignment": {
+ "description": "Creative Group Assignment.",
+ "id": "CreativeGroupAssignment",
+ "properties": {
+ "creativeGroupId": {
+ "description": "ID of the creative group to be assigned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativeGroupNumber": {
+ "description": "Creative group number of the creative group assignment.",
+ "enum": [
+ "CREATIVE_GROUP_ONE",
+ "CREATIVE_GROUP_TWO"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeGroupsListResponse": {
+ "description": "Creative Group List Response",
+ "id": "CreativeGroupsListResponse",
+ "properties": {
+ "creativeGroups": {
+ "description": "Creative group collection.",
+ "items": {
+ "$ref": "CreativeGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeOptimizationConfiguration": {
+ "description": "Creative optimization settings.",
+ "id": "CreativeOptimizationConfiguration",
+ "properties": {
+ "id": {
+ "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.",
+ "type": "string"
+ },
+ "optimizationActivitys": {
+ "description": "List of optimization activities associated with this configuration.",
+ "items": {
+ "$ref": "OptimizationActivity"
+ },
+ "type": "array"
+ },
+ "optimizationModel": {
+ "description": "Optimization model for this configuration.",
+ "enum": [
+ "CLICK",
+ "POST_CLICK",
+ "POST_IMPRESSION",
+ "POST_CLICK_AND_IMPRESSION",
+ "VIDEO_COMPLETION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeRotation": {
+ "description": "Creative Rotation.",
+ "id": "CreativeRotation",
+ "properties": {
+ "creativeAssignments": {
+ "description": "Creative assignments in this creative rotation.",
+ "items": {
+ "$ref": "CreativeAssignment"
+ },
+ "type": "array"
+ },
+ "creativeOptimizationConfigurationId": {
+ "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
+ "enum": [
+ "CREATIVE_ROTATION_TYPE_SEQUENTIAL",
+ "CREATIVE_ROTATION_TYPE_RANDOM"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "weightCalculationStrategy": {
+ "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
+ "enum": [
+ "WEIGHT_STRATEGY_EQUAL",
+ "WEIGHT_STRATEGY_CUSTOM",
+ "WEIGHT_STRATEGY_HIGHEST_CTR",
+ "WEIGHT_STRATEGY_OPTIMIZED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativesListResponse": {
+ "description": "Creative List Response",
+ "id": "CreativesListResponse",
+ "properties": {
+ "creatives": {
+ "description": "Creative collection.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CrossDimensionReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
+ "id": "CrossDimensionReachReportCompatibleFields",
+ "properties": {
+ "breakdown": {
+ "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "overlapMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomFloodlightVariable": {
+ "description": "A custom floodlight variable.",
+ "id": "CustomFloodlightVariable",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomRichMediaEvents": {
+ "description": "Represents a Custom Rich Media Events group.",
+ "id": "CustomRichMediaEvents",
+ "properties": {
+ "filteredEventIds": {
+ "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetric": {
+ "description": "Custom Viewability Metric",
+ "id": "CustomViewabilityMetric",
+ "properties": {
+ "configuration": {
+ "$ref": "CustomViewabilityMetricConfiguration",
+ "description": "Configuration of the custom viewability metric."
+ },
+ "id": {
+ "description": "ID of the custom viewability metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the custom viewability metric.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomViewabilityMetricConfiguration": {
+ "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
+ "id": "CustomViewabilityMetricConfiguration",
+ "properties": {
+ "audible": {
+ "description": "Whether the video must be audible to count an impression.",
+ "type": "boolean"
+ },
+ "timeMillis": {
+ "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "timePercent": {
+ "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "viewabilityPercent": {
+ "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "Represents a date range.",
+ "id": "DateRange",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dateRange.",
+ "type": "string"
+ },
+ "relativeDateRange": {
+ "description": "The date range relative to the date of when the report is run.",
+ "enum": [
+ "TODAY",
+ "YESTERDAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "LAST_24_MONTHS",
+ "LAST_14_DAYS",
+ "LAST_60_DAYS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DayPartTargeting": {
+ "description": "Day Part Targeting.",
+ "id": "DayPartTargeting",
+ "properties": {
+ "daysOfWeek": {
+ "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ",
+ "items": {
+ "enum": [
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hoursOfDay": {
+ "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "userLocalTime": {
+ "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeepLink": {
+ "description": "Contains information about a landing page deep link.",
+ "id": "DeepLink",
+ "properties": {
+ "appUrl": {
+ "description": "The URL of the mobile app being linked to.",
+ "type": "string"
+ },
+ "fallbackUrl": {
+ "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".",
+ "type": "string"
+ },
+ "mobileApp": {
+ "$ref": "MobileApp",
+ "description": "The mobile app targeted by this deep link."
+ },
+ "remarketingListIds": {
+ "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DefaultClickThroughEventTagProperties": {
+ "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
+ "id": "DefaultClickThroughEventTagProperties",
+ "properties": {
+ "defaultClickThroughEventTagId": {
+ "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
+ "format": "int64",
+ "type": "string"
+ },
+ "overrideInheritedEventTag": {
+ "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeliverySchedule": {
+ "description": "Delivery Schedule.",
+ "id": "DeliverySchedule",
+ "properties": {
+ "frequencyCap": {
+ "$ref": "FrequencyCap",
+ "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
+ },
+ "hardCutoff": {
+ "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.",
+ "type": "boolean"
+ },
+ "impressionRatio": {
+ "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "priority": {
+ "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
+ "enum": [
+ "AD_PRIORITY_01",
+ "AD_PRIORITY_02",
+ "AD_PRIORITY_03",
+ "AD_PRIORITY_04",
+ "AD_PRIORITY_05",
+ "AD_PRIORITY_06",
+ "AD_PRIORITY_07",
+ "AD_PRIORITY_08",
+ "AD_PRIORITY_09",
+ "AD_PRIORITY_10",
+ "AD_PRIORITY_11",
+ "AD_PRIORITY_12",
+ "AD_PRIORITY_13",
+ "AD_PRIORITY_14",
+ "AD_PRIORITY_15",
+ "AD_PRIORITY_16"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DfpSettings": {
+ "description": "Google Ad Manager Settings",
+ "id": "DfpSettings",
+ "properties": {
+ "dfpNetworkCode": {
+ "description": "Ad Manager network code for this directory site.",
+ "type": "string"
+ },
+ "dfpNetworkName": {
+ "description": "Ad Manager network name for this directory site.",
+ "type": "string"
+ },
+ "programmaticPlacementAccepted": {
+ "description": "Whether this directory site accepts programmatic placements.",
+ "type": "boolean"
+ },
+ "pubPaidPlacementAccepted": {
+ "description": "Whether this directory site accepts publisher-paid tags.",
+ "type": "boolean"
+ },
+ "publisherPortalOnly": {
+ "description": "Whether this directory site is available only via Publisher Portal.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "Represents a dimension.",
+ "id": "Dimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The dimension name, e.g. dfa:advertiser",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionFilter": {
+ "description": "Represents a dimension filter.",
+ "id": "DimensionFilter",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension to filter.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension to filter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValue": {
+ "description": "Represents a DimensionValue resource.",
+ "id": "DimensionValue",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID associated with the value if available.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "EXACT",
+ "BEGINS_WITH",
+ "CONTAINS",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the dimension.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueList": {
+ "description": "Represents the list of DimensionValue resources.",
+ "id": "DimensionValueList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The dimension values returned in this response.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionValueRequest": {
+ "description": "Represents a DimensionValuesRequest.",
+ "id": "DimensionValueRequest",
+ "properties": {
+ "dimensionName": {
+ "annotations": {
+ "required": [
+ "dfareporting.dimensionValues.query"
+ ]
+ },
+ "description": "The name of the dimension for which values should be requested.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The list of filters by which to filter values. The filters are ANDed.",
+ "items": {
+ "$ref": "DimensionFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySite": {
+ "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
+ "id": "DirectorySite",
+ "properties": {
+ "id": {
+ "description": "ID of this directory site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
+ },
+ "inpageTagFormats": {
+ "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ",
+ "items": {
+ "enum": [
+ "STANDARD",
+ "IFRAME_JAVASCRIPT_INPAGE",
+ "INTERNAL_REDIRECT_INPAGE",
+ "JAVASCRIPT_INPAGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "interstitialTagFormats": {
+ "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ",
+ "items": {
+ "enum": [
+ "IFRAME_JAVASCRIPT_INTERSTITIAL",
+ "INTERNAL_REDIRECT_INTERSTITIAL",
+ "JAVASCRIPT_INTERSTITIAL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this directory site.",
+ "type": "string"
+ },
+ "settings": {
+ "$ref": "DirectorySiteSettings",
+ "description": "Directory site settings."
+ },
+ "url": {
+ "description": "URL of this directory site.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySiteSettings": {
+ "description": "Directory Site Settings",
+ "id": "DirectorySiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether this directory site has disabled active view creatives.",
+ "type": "boolean"
+ },
+ "dfpSettings": {
+ "$ref": "DfpSettings",
+ "description": "Directory site Ad Manager settings."
+ },
+ "instreamVideoPlacementAccepted": {
+ "description": "Whether this site accepts in-stream video ads.",
+ "type": "boolean"
+ },
+ "interstitialPlacementAccepted": {
+ "description": "Whether this site accepts interstitial ads.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DirectorySitesListResponse": {
+ "description": "Directory Site List Response",
+ "id": "DirectorySitesListResponse",
+ "properties": {
+ "directorySites": {
+ "description": "Directory site collection.",
+ "items": {
+ "$ref": "DirectorySite"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DisjunctiveMatchStatement": {
+ "description": "Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.",
+ "id": "DisjunctiveMatchStatement",
+ "properties": {
+ "eventFilters": {
+ "description": "The event filters contained within this disjunctive match statement.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKey": {
+ "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
+ "id": "DynamicTargetingKey",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_ADVERTISER",
+ "OBJECT_AD",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicTargetingKeysListResponse": {
+ "description": "Dynamic Targeting Key List Response",
+ "id": "DynamicTargetingKeysListResponse",
+ "properties": {
+ "dynamicTargetingKeys": {
+ "description": "Dynamic targeting key collection.",
+ "items": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EncryptionInfo": {
+ "description": "A description of how user IDs are encrypted.",
+ "id": "EncryptionInfo",
+ "properties": {
+ "encryptionEntityId": {
+ "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "encryptionEntityType": {
+ "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
+ "enum": [
+ "ENCRYPTION_ENTITY_TYPE_UNKNOWN",
+ "DCM_ACCOUNT",
+ "DCM_ADVERTISER",
+ "DBM_PARTNER",
+ "DBM_ADVERTISER",
+ "ADWORDS_CUSTOMER",
+ "DFP_NETWORK_CODE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "encryptionSource": {
+ "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
+ "enum": [
+ "ENCRYPTION_SCOPE_UNKNOWN",
+ "AD_SERVING",
+ "DATA_TRANSFER"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventFilter": {
+ "description": "Represents a DfaReporting event filter.",
+ "id": "EventFilter",
+ "properties": {
+ "dimensionFilter": {
+ "$ref": "PathReportDimensionValue",
+ "description": "The dimension filter contained within this EventFilter."
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#eventFilter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTag": {
+ "description": "Contains properties of an event tag.",
+ "id": "EventTag",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "campaignId": {
+ "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "enabledByDefault": {
+ "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.",
+ "type": "boolean"
+ },
+ "excludeFromAdxRequests": {
+ "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this event tag. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "siteFilterType": {
+ "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
+ "enum": [
+ "ALLOWLIST",
+ "BLOCKLIST"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "siteIds": {
+ "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sslCompliant": {
+ "description": "Whether this tag is SSL-compliant or not. This is a read-only field.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
+ "enum": [
+ "ENABLED",
+ "DISABLED"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
+ "enum": [
+ "IMPRESSION_IMAGE_EVENT_TAG",
+ "IMPRESSION_JAVASCRIPT_EVENT_TAG",
+ "CLICK_THROUGH_EVENT_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.",
+ "type": "string"
+ },
+ "urlEscapeLevels": {
+ "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagOverride": {
+ "description": "Event tag override information.",
+ "id": "EventTagOverride",
+ "properties": {
+ "enabled": {
+ "description": "Whether this override is enabled.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this event tag override. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTagsListResponse": {
+ "description": "Event Tag List Response",
+ "id": "EventTagsListResponse",
+ "properties": {
+ "eventTags": {
+ "description": "Event tag collection.",
+ "items": {
+ "$ref": "EventTag"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "File": {
+ "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
+ "id": "File",
+ "properties": {
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename of the file.",
+ "type": "string"
+ },
+ "format": {
+ "description": "The output format of the report. Only available once the file is available.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of this report file.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "description": "The timestamp in milliseconds since epoch when this file was last modified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The ID of the report this file was generated from.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the report file.",
+ "enum": [
+ "PROCESSING",
+ "REPORT_AVAILABLE",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "urls": {
+ "description": "The URLs where the completed report file can be downloaded.",
+ "properties": {
+ "apiUrl": {
+ "description": "The URL for downloading the report data through the API.",
+ "type": "string"
+ },
+ "browserUrl": {
+ "description": "The URL for downloading the report data through a browser.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "FileList": {
+ "description": "List of files for a report.",
+ "id": "FileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The files returned in this response.",
+ "items": {
+ "$ref": "File"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Flight": {
+ "description": "Flight",
+ "id": "Flight",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "rateOrCost": {
+ "description": "Rate or cost of this flight.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this flight.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesGenerateTagResponse": {
+ "description": "Floodlight Activity GenerateTag Response",
+ "id": "FloodlightActivitiesGenerateTagResponse",
+ "properties": {
+ "floodlightActivityTag": {
+ "description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
+ "type": "string"
+ },
+ "globalSiteTagGlobalSnippet": {
+ "description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivitiesListResponse": {
+ "description": "Floodlight Activity List Response",
+ "id": "FloodlightActivitiesListResponse",
+ "properties": {
+ "floodlightActivities": {
+ "description": "Floodlight activity collection.",
+ "items": {
+ "$ref": "FloodlightActivity"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivity": {
+ "description": "Contains properties of a Floodlight activity.",
+ "id": "FloodlightActivity",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "attributionEnabled": {
+ "description": "Whether the activity is enabled for attribution.",
+ "type": "boolean"
+ },
+ "cacheBustingType": {
+ "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
+ "enum": [
+ "JAVASCRIPT",
+ "ACTIVE_SERVER_PAGE",
+ "JSP",
+ "PHP",
+ "COLD_FUSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "countingMethod": {
+ "description": "Counting method for conversions for this floodlight activity. This is a required field.",
+ "enum": [
+ "STANDARD_COUNTING",
+ "UNIQUE_COUNTING",
+ "SESSION_COUNTING",
+ "TRANSACTIONS_COUNTING",
+ "ITEMS_SOLD_COUNTING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "defaultTags": {
+ "description": "Dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityDynamicTag"
+ },
+ "type": "array"
+ },
+ "expectedUrl": {
+ "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
+ "type": "string"
+ },
+ "floodlightActivityGroupId": {
+ "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityGroupName": {
+ "description": "Name of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupTagString": {
+ "description": "Tag string of the associated floodlight activity group. This is a read-only field.",
+ "type": "string"
+ },
+ "floodlightActivityGroupType": {
+ "description": "Type of the associated floodlight activity group. This is a read-only field.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "floodlightTagType": {
+ "description": "The type of Floodlight tag this activity will generate. This is a required field.",
+ "enum": [
+ "IFRAME",
+ "IMAGE",
+ "GLOBAL_SITE_TAG"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "General notes or implementation instructions for the tag.",
+ "type": "string"
+ },
+ "publisherTags": {
+ "description": "Publisher dynamic floodlight tags.",
+ "items": {
+ "$ref": "FloodlightActivityPublisherDynamicTag"
+ },
+ "type": "array"
+ },
+ "secure": {
+ "description": "Whether this tag should use SSL.",
+ "type": "boolean"
+ },
+ "sslCompliant": {
+ "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
+ "type": "boolean"
+ },
+ "sslRequired": {
+ "description": "Whether this floodlight activity must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.",
+ "enum": [
+ "ACTIVE",
+ "ARCHIVED_AND_DISABLED",
+ "ARCHIVED",
+ "DISABLED_POLICY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormat": {
+ "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
+ "enum": [
+ "HTML",
+ "XHTML"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "userDefinedVariableTypes": {
+ "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
+ "items": {
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityDynamicTag": {
+ "description": "Dynamic Tag",
+ "id": "FloodlightActivityDynamicTag",
+ "properties": {
+ "id": {
+ "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this tag.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Tag code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroup": {
+ "description": "Contains properties of a Floodlight activity group.",
+ "id": "FloodlightActivityGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "floodlightConfigurationId": {
+ "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightConfigurationIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagString": {
+ "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
+ "enum": [
+ "COUNTER",
+ "SALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityGroupsListResponse": {
+ "description": "Floodlight Activity Group List Response",
+ "id": "FloodlightActivityGroupsListResponse",
+ "properties": {
+ "floodlightActivityGroups": {
+ "description": "Floodlight activity group collection.",
+ "items": {
+ "$ref": "FloodlightActivityGroup"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightActivityPublisherDynamicTag": {
+ "description": "Publisher Dynamic Tag",
+ "id": "FloodlightActivityPublisherDynamicTag",
+ "properties": {
+ "clickThrough": {
+ "description": "Whether this tag is applicable only for click-throughs.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dynamicTag": {
+ "$ref": "FloodlightActivityDynamicTag",
+ "description": "Dynamic floodlight tag."
+ },
+ "siteId": {
+ "description": "Site ID of this dynamic tag.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "viewThrough": {
+ "description": "Whether this tag is applicable only for view-throughs.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfiguration": {
+ "description": "Contains properties of a Floodlight configuration.",
+ "id": "FloodlightConfiguration",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "analyticsDataSharingEnabled": {
+ "description": "Whether advertiser data is shared with Google Analytics.",
+ "type": "boolean"
+ },
+ "customViewabilityMetric": {
+ "$ref": "CustomViewabilityMetric",
+ "description": "Custom Viewability metric for the floodlight configuration."
+ },
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "firstDayOfWeek": {
+ "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
+ "enum": [
+ "MONDAY",
+ "SUNDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
+ },
+ "inAppAttributionTrackingEnabled": {
+ "description": "Whether in-app attribution tracking is enabled.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
+ "type": "string"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this floodlight configuration."
+ },
+ "naturalSearchConversionAttributionOption": {
+ "description": "Types of attribution options for natural search conversions.",
+ "enum": [
+ "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
+ "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "omnitureSettings": {
+ "$ref": "OmnitureSettings",
+ "description": "Settings for Campaign Manager Omniture integration."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagSettings": {
+ "$ref": "TagSettings",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "thirdPartyAuthenticationTokens": {
+ "description": "List of third-party authentication tokens enabled for this configuration.",
+ "items": {
+ "$ref": "ThirdPartyAuthenticationToken"
+ },
+ "type": "array"
+ },
+ "userDefinedVariableConfigurations": {
+ "description": "List of user defined variables enabled for this configuration.",
+ "items": {
+ "$ref": "UserDefinedVariableConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightConfigurationsListResponse": {
+ "description": "Floodlight Configuration List Response",
+ "id": "FloodlightConfigurationsListResponse",
+ "properties": {
+ "floodlightConfigurations": {
+ "description": "Floodlight configuration collection.",
+ "items": {
+ "$ref": "FloodlightConfiguration"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FloodlightReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
+ "id": "FloodlightReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FrequencyCap": {
+ "description": "Frequency Cap.",
+ "id": "FrequencyCap",
+ "properties": {
+ "duration": {
+ "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "impressions": {
+ "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FsCommand": {
+ "description": "FsCommand.",
+ "id": "FsCommand",
+ "properties": {
+ "left": {
+ "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "positionOption": {
+ "description": "Position in the browser where the window will open.",
+ "enum": [
+ "CENTERED",
+ "DISTANCE_FROM_TOP_LEFT_CORNER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "top": {
+ "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowHeight": {
+ "description": "Height of the window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "windowWidth": {
+ "description": "Width of the window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GeoTargeting": {
+ "description": "Geographical Targeting.",
+ "id": "GeoTargeting",
+ "properties": {
+ "cities": {
+ "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
+ "items": {
+ "$ref": "City"
+ },
+ "type": "array"
+ },
+ "countries": {
+ "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
+ "items": {
+ "$ref": "Country"
+ },
+ "type": "array"
+ },
+ "excludeCountries": {
+ "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.",
+ "type": "boolean"
+ },
+ "metros": {
+ "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ },
+ "postalCodes": {
+ "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ },
+ "regions": {
+ "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItem": {
+ "description": "Represents a buy from the Planning inventory store.",
+ "id": "InventoryItem",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adSlots": {
+ "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
+ "items": {
+ "$ref": "AdSlot"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "Content category ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedClickThroughRate": {
+ "description": "Estimated click-through rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "estimatedConversionRate": {
+ "description": "Estimated conversion rate of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inPlan": {
+ "description": "Whether this inventory item is in plan.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this inventory item."
+ },
+ "name": {
+ "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.",
+ "type": "string"
+ },
+ "negotiationChannelId": {
+ "description": "Negotiation channel ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "Order ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "Placement strategy ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricing": {
+ "$ref": "Pricing",
+ "description": "Pricing of this inventory item."
+ },
+ "projectId": {
+ "description": "Project ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "rfpId": {
+ "description": "RFP ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "ID of the site this inventory item is associated with.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this inventory item.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_TYPE_REGULAR",
+ "PLANNING_PLACEMENT_TYPE_CREDIT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryItemsListResponse": {
+ "description": "Inventory item List Response",
+ "id": "InventoryItemsListResponse",
+ "properties": {
+ "inventoryItems": {
+ "description": "Inventory item collection",
+ "items": {
+ "$ref": "InventoryItem"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "KeyValueTargetingExpression": {
+ "description": "Key Value Targeting Expression.",
+ "id": "KeyValueTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Keyword expression being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LandingPage": {
+ "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
+ "id": "LandingPage",
+ "properties": {
+ "advertiserId": {
+ "description": "Advertiser ID of this landing page. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "archived": {
+ "description": "Whether this landing page has been archived.",
+ "type": "boolean"
+ },
+ "deepLinks": {
+ "description": "Links that will direct the user to a mobile app, if installed.",
+ "items": {
+ "$ref": "DeepLink"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this landing page. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of this landing page. This is a required field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Language": {
+ "description": "Contains information about a language that can be targeted by ads.",
+ "id": "Language",
+ "properties": {
+ "id": {
+ "description": "Language ID of this language. This is the ID used for targeting and generating reports.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this language.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LanguageTargeting": {
+ "description": "Language Targeting.",
+ "id": "LanguageTargeting",
+ "properties": {
+ "languages": {
+ "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LanguagesListResponse": {
+ "description": "Language List Response",
+ "id": "LanguagesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Language collection.",
+ "items": {
+ "$ref": "Language"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LastModifiedInfo": {
+ "description": "Modification timestamp.",
+ "id": "LastModifiedInfo",
+ "properties": {
+ "time": {
+ "description": "Timestamp of the last change in milliseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationClause": {
+ "description": "A group clause made up of list population terms representing constraints joined by ORs.",
+ "id": "ListPopulationClause",
+ "properties": {
+ "terms": {
+ "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationTerm"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationRule": {
+ "description": "Remarketing List Population Rule.",
+ "id": "ListPopulationRule",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityName": {
+ "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "listPopulationClauses": {
+ "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
+ "items": {
+ "$ref": "ListPopulationClause"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPopulationTerm": {
+ "description": "Remarketing List Population Rule Term.",
+ "id": "ListPopulationTerm",
+ "properties": {
+ "contains": {
+ "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
+ "type": "boolean"
+ },
+ "negation": {
+ "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "enum": [
+ "NUM_EQUALS",
+ "NUM_LESS_THAN",
+ "NUM_LESS_THAN_EQUAL",
+ "NUM_GREATER_THAN",
+ "NUM_GREATER_THAN_EQUAL",
+ "STRING_EQUALS",
+ "STRING_CONTAINS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
+ "enum": [
+ "CUSTOM_VARIABLE_TERM",
+ "LIST_MEMBERSHIP_TERM",
+ "REFERRER_TERM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ },
+ "variableFriendlyName": {
+ "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
+ "type": "string"
+ },
+ "variableName": {
+ "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListTargetingExpression": {
+ "description": "Remarketing List Targeting Expression.",
+ "id": "ListTargetingExpression",
+ "properties": {
+ "expression": {
+ "description": "Expression describing which lists are being targeted by the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LookbackConfiguration": {
+ "description": "Lookback configuration settings.",
+ "id": "LookbackConfiguration",
+ "properties": {
+ "clickDuration": {
+ "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "postImpressionActivitiesDuration": {
+ "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "MeasurementPartnerAdvertiserLink": {
+ "id": "MeasurementPartnerAdvertiserLink",
+ "properties": {
+ "linkStatus": {
+ "description": ".",
+ "enum": [
+ "MEASUREMENT_PARTNER_UNLINKED",
+ "MEASUREMENT_PARTNER_LINKED",
+ "MEASUREMENT_PARTNER_LINK_PENDING",
+ "MEASUREMENT_PARTNER_LINK_FAILURE",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING",
+ "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING",
+ "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "measurementPartner": {
+ "description": "Measurement partner used for tag wrapping.",
+ "enum": [
+ "NONE",
+ "INTEGRAL_AD_SCIENCE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "partnerAdvertiserId": {
+ "description": ".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MeasurementPartnerCampaignLink": {
+ "id": "MeasurementPartnerCampaignLink",
+ "properties": {
+ "linkStatus": {
+ "description": ".",
+ "enum": [
+ "MEASUREMENT_PARTNER_UNLINKED",
+ "MEASUREMENT_PARTNER_LINKED",
+ "MEASUREMENT_PARTNER_LINK_PENDING",
+ "MEASUREMENT_PARTNER_LINK_FAILURE",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING",
+ "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING",
+ "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "measurementPartner": {
+ "description": "Measurement partner used for tag wrapping.",
+ "enum": [
+ "NONE",
+ "INTEGRAL_AD_SCIENCE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "partnerCampaignId": {
+ "description": "Partner campaign ID needed for establishing linking with Measurement partner.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MeasurementPartnerWrappingData": {
+ "description": "Placement tag wrapping",
+ "id": "MeasurementPartnerWrappingData",
+ "properties": {
+ "linkStatus": {
+ "description": "Placement wrapping status.",
+ "enum": [
+ "MEASUREMENT_PARTNER_UNLINKED",
+ "MEASUREMENT_PARTNER_LINKED",
+ "MEASUREMENT_PARTNER_LINK_PENDING",
+ "MEASUREMENT_PARTNER_LINK_FAILURE",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT",
+ "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING",
+ "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING",
+ "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "measurementPartner": {
+ "description": "Measurement partner used for wrapping the placement.",
+ "enum": [
+ "NONE",
+ "INTEGRAL_AD_SCIENCE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "tagWrappingMode": {
+ "description": "Measurement mode for the wrapped placement.",
+ "enum": [
+ "NONE",
+ "BLOCKING",
+ "MONITORING",
+ "MONITORING_ONLY",
+ "VIDEO_PIXEL_MONITORING",
+ "TRACKING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "wrappedTag": {
+ "description": "Tag provided by the measurement partner during wrapping.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metric": {
+ "description": "Represents a metric.",
+ "id": "Metric",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#metric.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The metric name, e.g. dfa:impressions",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metro": {
+ "description": "Contains information about a metro region that can be targeted by ads.",
+ "id": "Metro",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this metro region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this metro region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this metro region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dmaId": {
+ "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
+ "type": "string"
+ },
+ "metroCode": {
+ "description": "Metro code of this metro region. This is equivalent to dma_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this metro region.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetrosListResponse": {
+ "description": "Metro List Response",
+ "id": "MetrosListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
+ "type": "string"
+ },
+ "metros": {
+ "description": "Metro collection.",
+ "items": {
+ "$ref": "Metro"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MobileApp": {
+ "description": "Contains information about a mobile app. Used as a landing page deep link.",
+ "id": "MobileApp",
+ "properties": {
+ "directory": {
+ "description": "Mobile app directory.",
+ "enum": [
+ "UNKNOWN",
+ "APPLE_APP_STORE",
+ "GOOGLE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile app.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
+ "type": "string"
+ },
+ "publisherName": {
+ "description": "Publisher name.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this mobile app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileAppsListResponse": {
+ "description": "Mobile app List Response",
+ "id": "MobileAppsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
+ "type": "string"
+ },
+ "mobileApps": {
+ "description": "Mobile apps collection.",
+ "items": {
+ "$ref": "MobileApp"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarrier": {
+ "description": "Contains information about a mobile carrier that can be targeted by ads.",
+ "id": "MobileCarrier",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this mobile carrier belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this mobile carrier belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this mobile carrier.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this mobile carrier.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileCarriersListResponse": {
+ "description": "Mobile Carrier List Response",
+ "id": "MobileCarriersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
+ "type": "string"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carrier collection.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ObaIcon": {
+ "description": "Online Behavioral Advertiser icon.",
+ "id": "ObaIcon",
+ "properties": {
+ "iconClickThroughUrl": {
+ "description": "URL to redirect to when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "iconClickTrackingUrl": {
+ "description": "URL to track click when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "iconViewTrackingUrl": {
+ "description": "URL to track view when an OBA icon is clicked.",
+ "type": "string"
+ },
+ "program": {
+ "description": "Identifies the industry initiative that the icon supports. For example, AdChoices.",
+ "type": "string"
+ },
+ "resourceUrl": {
+ "description": "OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "OBA icon size."
+ },
+ "xPosition": {
+ "description": "OBA icon x coordinate position. Accepted values are left or right.",
+ "type": "string"
+ },
+ "yPosition": {
+ "description": "OBA icon y coordinate position. Accepted values are top or bottom.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ObjectFilter": {
+ "description": "Object Filter.",
+ "id": "ObjectFilter",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
+ "type": "string"
+ },
+ "objectIds": {
+ "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
+ "enum": [
+ "NONE",
+ "ASSIGNED",
+ "ALL"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OffsetPosition": {
+ "description": "Offset Position.",
+ "id": "OffsetPosition",
+ "properties": {
+ "left": {
+ "description": "Offset distance from left side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "top": {
+ "description": "Offset distance from top side of an asset or a window.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OmnitureSettings": {
+ "description": "Omniture Integration Settings.",
+ "id": "OmnitureSettings",
+ "properties": {
+ "omnitureCostDataEnabled": {
+ "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
+ "type": "boolean"
+ },
+ "omnitureIntegrationEnabled": {
+ "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystem": {
+ "description": "Contains information about an operating system that can be targeted by ads.",
+ "id": "OperatingSystem",
+ "properties": {
+ "dartId": {
+ "description": "DART ID of this operating system. This is the ID used for targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "desktop": {
+ "description": "Whether this operating system is for desktop.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
+ "type": "string"
+ },
+ "mobile": {
+ "description": "Whether this operating system is for mobile.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Name of this operating system.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersion": {
+ "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
+ "id": "OperatingSystemVersion",
+ "properties": {
+ "id": {
+ "description": "ID of this operating system version.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
+ "type": "string"
+ },
+ "majorVersion": {
+ "description": "Major version (leftmost number) of this operating system version.",
+ "type": "string"
+ },
+ "minorVersion": {
+ "description": "Minor version (number after the first dot) of this operating system version.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this operating system version.",
+ "type": "string"
+ },
+ "operatingSystem": {
+ "$ref": "OperatingSystem",
+ "description": "Operating system of this operating system version."
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemVersionsListResponse": {
+ "description": "Operating System Version List Response",
+ "id": "OperatingSystemVersionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system version collection.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperatingSystemsListResponse": {
+ "description": "Operating System List Response",
+ "id": "OperatingSystemsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
+ "type": "string"
+ },
+ "operatingSystems": {
+ "description": "Operating system collection.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OptimizationActivity": {
+ "description": "Creative optimization activity.",
+ "id": "OptimizationActivity",
+ "properties": {
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID of this optimization activity. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "floodlightActivityIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
+ },
+ "weight": {
+ "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Order": {
+ "description": "Describes properties of a Planning order.",
+ "id": "Order",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approverUserProfileIds": {
+ "description": "IDs for users that have to approve documents created for this order.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "buyerInvoiceId": {
+ "description": "Buyer invoice ID associated with this order.",
+ "type": "string"
+ },
+ "buyerOrganizationName": {
+ "description": "Name of the buyer organization.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "Comments in this order.",
+ "type": "string"
+ },
+ "contacts": {
+ "description": "Contacts for this order.",
+ "items": {
+ "$ref": "OrderContact"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this order. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this order."
+ },
+ "name": {
+ "description": "Name of this order.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Notes of this order.",
+ "type": "string"
+ },
+ "planningTermId": {
+ "description": "ID of the terms and conditions template used in this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sellerOrderId": {
+ "description": "Seller order ID associated with this order.",
+ "type": "string"
+ },
+ "sellerOrganizationName": {
+ "description": "Name of the seller organization.",
+ "type": "string"
+ },
+ "siteId": {
+ "description": "Site IDs this order is associated with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "siteNames": {
+ "description": "Free-form site names this order is associated with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order.",
+ "format": "int64",
+ "type": "string"
+ },
+ "termsAndConditions": {
+ "description": "Terms and conditions of this order.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderContact": {
+ "description": "Contact of an order.",
+ "id": "OrderContact",
+ "properties": {
+ "contactInfo": {
+ "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "Name of this contact.",
+ "type": "string"
+ },
+ "contactTitle": {
+ "description": "Title of this contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Type of this contact.",
+ "enum": [
+ "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
+ "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
+ "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "signatureUserProfileId": {
+ "description": "ID of the user profile containing the signature that will be embedded into order documents.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocument": {
+ "description": "Contains properties of a Planning order document.",
+ "id": "OrderDocument",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "amendedOrderDocumentId": {
+ "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approvedByUserProfileIds": {
+ "description": "IDs of users who have approved this order document.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "cancelled": {
+ "description": "Whether this order document is cancelled.",
+ "type": "boolean"
+ },
+ "createdInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this order document."
+ },
+ "effectiveDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
+ "type": "string"
+ },
+ "lastSentRecipients": {
+ "description": "List of email addresses that received the last sent document.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "lastSentTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "ID of the order from which this order document is created.",
+ "format": "int64",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "signed": {
+ "description": "Whether this order document has been signed.",
+ "type": "boolean"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this order document.",
+ "format": "int64",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this order document.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this order document",
+ "enum": [
+ "PLANNING_ORDER_TYPE_INSERTION_ORDER",
+ "PLANNING_ORDER_TYPE_CHANGE_ORDER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderDocumentsListResponse": {
+ "description": "Order document List Response",
+ "id": "OrderDocumentsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orderDocuments": {
+ "description": "Order document collection",
+ "items": {
+ "$ref": "OrderDocument"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersListResponse": {
+ "description": "Order List Response",
+ "id": "OrdersListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "orders": {
+ "description": "Order collection.",
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathFilter": {
+ "description": "Represents a DfaReporting path filter.",
+ "id": "PathFilter",
+ "properties": {
+ "eventFilters": {
+ "description": "Event filters in path report.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathFilter.",
+ "type": "string"
+ },
+ "pathMatchPosition": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "PATH_MATCH_POSITION_UNSPECIFIED",
+ "ANY",
+ "FIRST",
+ "LAST"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PathReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"PATH\".",
+ "id": "PathReportCompatibleFields",
+ "properties": {
+ "channelGroupings": {
+ "description": "Dimensions which are compatible to be selected in the \"channelGroupings\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pathFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"pathFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathReportDimensionValue": {
+ "description": "Represents a PathReportDimensionValue resource.",
+ "id": "PathReportDimensionValue",
+ "properties": {
+ "dimensionName": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "ids": {
+ "description": "The possible ID's associated with the value if available.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathReportDimensionValue.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
+ "enum": [
+ "EXACT",
+ "BEGINS_WITH",
+ "CONTAINS",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "The possible values of the dimension.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathToConversionReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
+ "id": "PathToConversionReportCompatibleFields",
+ "properties": {
+ "conversionDimensions": {
+ "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "customFloodlightVariables": {
+ "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "perInteractionDimensions": {
+ "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Placement": {
+ "description": "Contains properties of a placement.",
+ "id": "Placement",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
+ "type": "boolean"
+ },
+ "additionalSizes": {
+ "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement. This field is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "comment": {
+ "description": "Comments for this placement.",
+ "type": "string"
+ },
+ "compatibility": {
+ "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
+ "enum": [
+ "DISPLAY",
+ "DISPLAY_INTERSTITIAL",
+ "APP",
+ "APP_INTERSTITIAL",
+ "IN_STREAM_VIDEO",
+ "IN_STREAM_AUDIO"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this placement. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement. This is a read-only field."
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Lookback window settings for this placement."
+ },
+ "name": {
+ "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.",
+ "type": "string"
+ },
+ "partnerWrappingData": {
+ "$ref": "MeasurementPartnerWrappingData",
+ "description": "Measurement partner provided settings for a wrapped placement."
+ },
+ "paymentApproved": {
+ "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
+ "type": "boolean"
+ },
+ "paymentSource": {
+ "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
+ "enum": [
+ "PLACEMENT_AGENCY_PAID",
+ "PLACEMENT_PUBLISHER_PAID"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementGroupId": {
+ "description": "ID of this placement's group, if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementGroupIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
+ },
+ "primary": {
+ "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
+ "type": "boolean"
+ },
+ "publisherUpdateInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the last publisher update. This is a read-only field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
+ },
+ "sslRequired": {
+ "description": "Whether creatives assigned to this placement must be SSL-compliant.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Third-party placement status.",
+ "enum": [
+ "PENDING_REVIEW",
+ "PAYMENT_ACCEPTED",
+ "PAYMENT_REJECTED",
+ "ACKNOWLEDGE_REJECTION",
+ "ACKNOWLEDGE_ACCEPTANCE",
+ "DRAFT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement. This field can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagFormats": {
+ "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
+ "items": {
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Tag settings for this placement."
+ },
+ "videoActiveViewOptOut": {
+ "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
+ "type": "boolean"
+ },
+ "videoSettings": {
+ "$ref": "VideoSettings",
+ "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
+ },
+ "vpaidAdapterChoice": {
+ "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "wrappingOptOut": {
+ "description": "Whether this placement opts out of tag wrapping.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementAssignment": {
+ "description": "Placement Assignment.",
+ "id": "PlacementAssignment",
+ "properties": {
+ "active": {
+ "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
+ "type": "boolean"
+ },
+ "placementId": {
+ "description": "ID of the placement to be assigned. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
+ },
+ "sslRequired": {
+ "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroup": {
+ "description": "Contains properties of a package or roadblock.",
+ "id": "PlacementGroup",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this placement group. This is a required field on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "archived": {
+ "description": "Whether this placement group is archived.",
+ "type": "boolean"
+ },
+ "campaignId": {
+ "description": "Campaign ID of this placement group. This field is required on insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "campaignIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
+ },
+ "childPlacementIds": {
+ "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "comment": {
+ "description": "Comments for this placement group.",
+ "type": "string"
+ },
+ "contentCategoryId": {
+ "description": "ID of the content category assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the creation of this placement group. This is a read-only field."
+ },
+ "directorySiteId": {
+ "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "externalId": {
+ "description": "External ID for this placement.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement group. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this placement group. This is a read-only field."
+ },
+ "name": {
+ "description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
+ "type": "string"
+ },
+ "placementGroupType": {
+ "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
+ "enum": [
+ "PLACEMENT_PACKAGE",
+ "PLACEMENT_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "placementStrategyId": {
+ "description": "ID of the placement strategy assigned to this placement group.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingSchedule": {
+ "$ref": "PricingSchedule",
+ "description": "Pricing schedule of this placement group. This field is required on insertion."
+ },
+ "primaryPlacementId": {
+ "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
+ "format": "int64",
+ "type": "string"
+ },
+ "primaryPlacementIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
+ },
+ "siteId": {
+ "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "siteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementGroupsListResponse": {
+ "description": "Placement Group List Response",
+ "id": "PlacementGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placementGroups": {
+ "description": "Placement group collection.",
+ "items": {
+ "$ref": "PlacementGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategiesListResponse": {
+ "description": "Placement Strategy List Response",
+ "id": "PlacementStrategiesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placementStrategies": {
+ "description": "Placement strategy collection.",
+ "items": {
+ "$ref": "PlacementStrategy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementStrategy": {
+ "description": "Contains properties of a placement strategy.",
+ "id": "PlacementStrategy",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementTag": {
+ "description": "Placement Tag",
+ "id": "PlacementTag",
+ "properties": {
+ "placementId": {
+ "description": "Placement ID",
+ "format": "int64",
+ "type": "string"
+ },
+ "tagDatas": {
+ "description": "Tags generated for this placement.",
+ "items": {
+ "$ref": "TagData"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsGenerateTagsResponse": {
+ "description": "Placement GenerateTags Response",
+ "id": "PlacementsGenerateTagsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
+ "type": "string"
+ },
+ "placementTags": {
+ "description": "Set of generated tags for the specified placements.",
+ "items": {
+ "$ref": "PlacementTag"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlacementsListResponse": {
+ "description": "Placement List Response",
+ "id": "PlacementsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "placements": {
+ "description": "Placement collection.",
+ "items": {
+ "$ref": "Placement"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformType": {
+ "description": "Contains information about a platform type that can be targeted by ads.",
+ "id": "PlatformType",
+ "properties": {
+ "id": {
+ "description": "ID of this platform type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this platform type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformTypesListResponse": {
+ "description": "Platform Type List Response",
+ "id": "PlatformTypesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
+ "type": "string"
+ },
+ "platformTypes": {
+ "description": "Platform type collection.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PopupWindowProperties": {
+ "description": "Popup Window Properties.",
+ "id": "PopupWindowProperties",
+ "properties": {
+ "dimension": {
+ "$ref": "Size",
+ "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
+ },
+ "offset": {
+ "$ref": "OffsetPosition",
+ "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
+ },
+ "positionType": {
+ "description": "Popup window position either centered or at specific coordinate.",
+ "enum": [
+ "CENTER",
+ "COORDINATES"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "showAddressBar": {
+ "description": "Whether to display the browser address bar.",
+ "type": "boolean"
+ },
+ "showMenuBar": {
+ "description": "Whether to display the browser menu bar.",
+ "type": "boolean"
+ },
+ "showScrollBar": {
+ "description": "Whether to display the browser scroll bar.",
+ "type": "boolean"
+ },
+ "showStatusBar": {
+ "description": "Whether to display the browser status bar.",
+ "type": "boolean"
+ },
+ "showToolBar": {
+ "description": "Whether to display the browser tool bar.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Title of popup window.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCode": {
+ "description": "Contains information about a postal code that can be targeted by ads.",
+ "id": "PostalCode",
+ "properties": {
+ "code": {
+ "description": "Postal code. This is equivalent to the id field.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the country to which this postal code belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this postal code belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this postal code.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodesListResponse": {
+ "description": "Postal Code List Response",
+ "id": "PostalCodesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
+ "type": "string"
+ },
+ "postalCodes": {
+ "description": "Postal code collection.",
+ "items": {
+ "$ref": "PostalCode"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Pricing": {
+ "description": "Pricing Information",
+ "id": "Pricing",
+ "properties": {
+ "capCostType": {
+ "description": "Cap cost type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flights": {
+ "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
+ "items": {
+ "$ref": "Flight"
+ },
+ "type": "array"
+ },
+ "groupType": {
+ "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
+ "enum": [
+ "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
+ "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "pricingType": {
+ "description": "Pricing type of this inventory item.",
+ "enum": [
+ "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedule": {
+ "description": "Pricing Schedule",
+ "id": "PricingSchedule",
+ "properties": {
+ "capCostOption": {
+ "description": "Placement cap cost option.",
+ "enum": [
+ "CAP_COST_NONE",
+ "CAP_COST_MONTHLY",
+ "CAP_COST_CUMULATIVE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "flighted": {
+ "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.",
+ "type": "boolean"
+ },
+ "floodlightActivityId": {
+ "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pricingPeriods": {
+ "description": "Pricing periods for this placement.",
+ "items": {
+ "$ref": "PricingSchedulePricingPeriod"
+ },
+ "type": "array"
+ },
+ "pricingType": {
+ "description": "Placement pricing type. This field is required on insertion.",
+ "enum": [
+ "PRICING_TYPE_CPM",
+ "PRICING_TYPE_CPC",
+ "PRICING_TYPE_CPA",
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
+ "PRICING_TYPE_FLAT_RATE_CLICKS",
+ "PRICING_TYPE_CPM_ACTIVEVIEW"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "testingStartDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricingSchedulePricingPeriod": {
+ "description": "Pricing Period",
+ "id": "PricingSchedulePricingPeriod",
+ "properties": {
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "pricingComment": {
+ "description": "Comments for this pricing period.",
+ "type": "string"
+ },
+ "rateOrCostNanos": {
+ "description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "units": {
+ "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Project": {
+ "description": "Contains properties of a Planning project.",
+ "id": "Project",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "audienceAgeGroup": {
+ "description": "Audience age group of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_AGE_18_24",
+ "PLANNING_AUDIENCE_AGE_25_34",
+ "PLANNING_AUDIENCE_AGE_35_44",
+ "PLANNING_AUDIENCE_AGE_45_54",
+ "PLANNING_AUDIENCE_AGE_55_64",
+ "PLANNING_AUDIENCE_AGE_65_OR_MORE",
+ "PLANNING_AUDIENCE_AGE_UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "audienceGender": {
+ "description": "Audience gender of this project.",
+ "enum": [
+ "PLANNING_AUDIENCE_GENDER_MALE",
+ "PLANNING_AUDIENCE_GENDER_FEMALE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "budget": {
+ "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientBillingCode": {
+ "description": "Client billing code of this project.",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the project client.",
+ "type": "string"
+ },
+ "endDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this project. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
+ "type": "string"
+ },
+ "lastModifiedInfo": {
+ "$ref": "LastModifiedInfo",
+ "description": "Information about the most recent modification of this project."
+ },
+ "name": {
+ "description": "Name of this project.",
+ "type": "string"
+ },
+ "overview": {
+ "description": "Overview of this project.",
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this project.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetClicks": {
+ "description": "Number of clicks that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetConversions": {
+ "description": "Number of conversions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpaNanos": {
+ "description": "CPA that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpcNanos": {
+ "description": "CPC that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmActiveViewNanos": {
+ "description": "vCPM from Active View that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetCpmNanos": {
+ "description": "CPM that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ },
+ "targetImpressions": {
+ "description": "Number of impressions that the advertiser is targeting.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectsListResponse": {
+ "description": "Project List Response",
+ "id": "ProjectsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "projects": {
+ "description": "Project collection.",
+ "items": {
+ "$ref": "Project"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReachReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
+ "id": "ReachReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "reachByFrequencyMetrics": {
+ "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Recipient": {
+ "description": "Represents a recipient.",
+ "id": "Recipient",
+ "properties": {
+ "deliveryType": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The delivery type for the recipient.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The email address of the recipient.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#recipient.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Region": {
+ "description": "Contains information about a region that can be targeted by ads.",
+ "id": "Region",
+ "properties": {
+ "countryCode": {
+ "description": "Country code of the country to which this region belongs.",
+ "type": "string"
+ },
+ "countryDartId": {
+ "description": "DART ID of the country to which this region belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dartId": {
+ "description": "DART ID of this region.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this region.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "Region code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionsListResponse": {
+ "description": "Region List Response",
+ "id": "RegionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
+ "type": "string"
+ },
+ "regions": {
+ "description": "Region collection.",
+ "items": {
+ "$ref": "Region"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingList": {
+ "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
+ "id": "RemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "description": {
+ "description": "Remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listPopulationRule": {
+ "$ref": "ListPopulationRule",
+ "description": "Rule used to populate the remarketing list with users."
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListShare": {
+ "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
+ "id": "RemarketingListShare",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
+ "type": "string"
+ },
+ "remarketingListId": {
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sharedAccountIds": {
+ "description": "Accounts that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sharedAdvertiserIds": {
+ "description": "Advertisers that the remarketing list is shared with.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingListsListResponse": {
+ "description": "Remarketing list response",
+ "id": "RemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "remarketingLists": {
+ "description": "Remarketing list collection.",
+ "items": {
+ "$ref": "RemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "Represents a Report resource.",
+ "id": "Report",
+ "properties": {
+ "accountId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The account ID to which this report belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "criteria": {
+ "description": "The report criteria for a report of type \"STANDARD\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
+ },
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range for which this report should be run."
+ },
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "The list of standard dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "crossDimensionReachCriteria": {
+ "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
+ "properties": {
+ "breakdown": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "dimension": {
+ "description": "The dimension option.",
+ "enum": [
+ "ADVERTISER",
+ "CAMPAIGN",
+ "SITE_BY_ADVERTISER",
+ "SITE_BY_CAMPAIGN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "overlapMetricNames": {
+ "description": "The list of names of overlap metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pivoted": {
+ "description": "Whether the report is pivoted or not. Defaults to true.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "delivery": {
+ "description": "The report's email delivery settings.",
+ "properties": {
+ "emailOwner": {
+ "description": "Whether the report should be emailed to the report owner.",
+ "type": "boolean"
+ },
+ "emailOwnerDeliveryType": {
+ "description": "The type of delivery for the owner to receive, if enabled.",
+ "enum": [
+ "LINK",
+ "ATTACHMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "message": {
+ "description": "The message to be sent with each email.",
+ "type": "string"
+ },
+ "recipients": {
+ "description": "The list of recipients to which to email the report.",
+ "items": {
+ "$ref": "Recipient"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "The filename used when generating report files for this report.",
+ "type": "string"
+ },
+ "floodlightCriteria": {
+ "description": "The report criteria for a report of type \"FLOODLIGHT\".",
+ "properties": {
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "includeAttributedIPConversions": {
+ "description": "Include conversions that have no cookie, but do have an exposure path.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "format": {
+ "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
+ "enum": [
+ "CSV",
+ "EXCEL"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The unique ID identifying this report resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#report.",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The name of the report.",
+ "type": "string"
+ },
+ "ownerProfileId": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The user profile id of the owner of this report.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pathAttributionCriteria": {
+ "description": "The report criteria for a report of type \"PATH_ATTRIBUTION\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "customChannelGrouping": {
+ "$ref": "ChannelGrouping",
+ "description": "Channel Grouping."
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pathFilters": {
+ "description": "Path Filters.",
+ "items": {
+ "$ref": "PathFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "pathCriteria": {
+ "description": "The report criteria for a report of type \"PATH\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "customChannelGrouping": {
+ "$ref": "ChannelGrouping",
+ "description": "Channel Grouping."
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pathFilters": {
+ "description": "Path Filters.",
+ "items": {
+ "$ref": "PathFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "pathToConversionCriteria": {
+ "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
+ "properties": {
+ "activityFilters": {
+ "description": "The list of 'dfa:activity' values to filter on.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "conversionDimensions": {
+ "description": "The list of conversion dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "customFloodlightVariables": {
+ "description": "The list of custom floodlight variables the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "customRichMediaEvents": {
+ "description": "The list of custom rich media events to include.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "floodlightConfigId": {
+ "$ref": "DimensionValue",
+ "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "perInteractionDimensions": {
+ "description": "The list of per interaction dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "reportProperties": {
+ "description": "The properties of the report.",
+ "properties": {
+ "clicksLookbackWindow": {
+ "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionsLookbackWindow": {
+ "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "includeAttributedIPConversions": {
+ "description": "Deprecated: has no effect.",
+ "type": "boolean"
+ },
+ "includeUnattributedCookieConversions": {
+ "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
+ "type": "boolean"
+ },
+ "includeUnattributedIPConversions": {
+ "description": "Include conversions that have no associated cookies and no exposures. It\u2019s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
+ "type": "boolean"
+ },
+ "maximumClickInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumImpressionInteractions": {
+ "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumInteractionGap": {
+ "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pivotOnInteractionPath": {
+ "description": "Enable pivoting on interaction path.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "reachCriteria": {
+ "description": "The report criteria for a report of type \"REACH\".",
+ "properties": {
+ "activities": {
+ "$ref": "Activities",
+ "description": "Activity group."
+ },
+ "customRichMediaEvents": {
+ "$ref": "CustomRichMediaEvents",
+ "description": "Custom Rich Media Events group."
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "The date range this report should be run for."
+ },
+ "dimensionFilters": {
+ "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+ "items": {
+ "$ref": "DimensionValue"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "The list of dimensions the report should include.",
+ "items": {
+ "$ref": "SortedDimension"
+ },
+ "type": "array"
+ },
+ "enableAllDimensionCombinations": {
+ "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
+ "type": "boolean"
+ },
+ "metricNames": {
+ "description": "The list of names of metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reachByFrequencyMetricNames": {
+ "description": "The list of names of Reach By Frequency metrics the report should include.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schedule": {
+ "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
+ "properties": {
+ "active": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "Whether the schedule is active or not. Must be set to either true or false.",
+ "type": "boolean"
+ },
+ "every": {
+ "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
+ "format": "int32",
+ "type": "integer"
+ },
+ "expirationDate": {
+ "format": "date",
+ "type": "string"
+ },
+ "repeats": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ",
+ "type": "string"
+ },
+ "repeatsOnWeekDays": {
+ "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
+ "items": {
+ "enum": [
+ "SUNDAY",
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "runsOnDayOfMonth": {
+ "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
+ "enum": [
+ "DAY_OF_MONTH",
+ "WEEK_OF_MONTH"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "startDate": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "subAccountId": {
+ "description": "The subaccount ID to which this report belongs if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "dfareporting.reports.insert",
+ "dfareporting.reports.update"
+ ]
+ },
+ "description": "The type of the report.",
+ "enum": [
+ "STANDARD",
+ "REACH",
+ "PATH_TO_CONVERSION",
+ "CROSS_DIMENSION_REACH",
+ "FLOODLIGHT",
+ "PATH",
+ "PATH_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportCompatibleFields": {
+ "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
+ "id": "ReportCompatibleFields",
+ "properties": {
+ "dimensionFilters": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "pivotedActivityMetrics": {
+ "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportList": {
+ "description": "Represents the list of reports.",
+ "id": "ReportList",
+ "properties": {
+ "etag": {
+ "description": "The eTag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The reports returned in this response.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind of list this is, in this case dfareporting#reportList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportsConfiguration": {
+ "description": "Reporting Configuration",
+ "id": "ReportsConfiguration",
+ "properties": {
+ "exposureToConversionEnabled": {
+ "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
+ "type": "boolean"
+ },
+ "lookbackConfiguration": {
+ "$ref": "LookbackConfiguration",
+ "description": "Default lookback windows for new advertisers in this account."
+ },
+ "reportGenerationTimeZoneId": {
+ "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RichMediaExitOverride": {
+ "description": "Rich Media Exit Override.",
+ "id": "RichMediaExitOverride",
+ "properties": {
+ "clickThroughUrl": {
+ "$ref": "ClickThroughUrl",
+ "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
+ },
+ "enabled": {
+ "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.",
+ "type": "boolean"
+ },
+ "exitId": {
+ "description": "ID for the override to refer to a specific exit in the creative.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Rule": {
+ "description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
+ "id": "Rule",
+ "properties": {
+ "assetId": {
+ "description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "A user-friendly name for this rule. This is a required field.",
+ "type": "string"
+ },
+ "targetingTemplateId": {
+ "description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Site": {
+ "description": "Contains properties of a site.",
+ "id": "Site",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "approved": {
+ "description": "Whether this site is approved.",
+ "type": "boolean"
+ },
+ "directorySiteId": {
+ "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
+ "format": "int64",
+ "type": "string"
+ },
+ "directorySiteIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
+ },
+ "id": {
+ "description": "ID of this site. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "idDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
+ },
+ "keyName": {
+ "description": "Key name of this site. This is a read-only, auto-generated field.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.",
+ "type": "string"
+ },
+ "siteContacts": {
+ "description": "Site contacts.",
+ "items": {
+ "$ref": "SiteContact"
+ },
+ "type": "array"
+ },
+ "siteSettings": {
+ "$ref": "SiteSettings",
+ "description": "Site-wide settings."
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "videoSettings": {
+ "$ref": "SiteVideoSettings",
+ "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
+ }
+ },
+ "type": "object"
+ },
+ "SiteCompanionSetting": {
+ "description": "Companion Settings",
+ "id": "SiteCompanionSetting",
+ "properties": {
+ "companionsDisabled": {
+ "description": "Whether companions are disabled for this site template.",
+ "type": "boolean"
+ },
+ "enabledSizes": {
+ "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ },
+ "imageOnly": {
+ "description": "Whether to serve only static images as companions.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteContact": {
+ "description": "Site Contact",
+ "id": "SiteContact",
+ "properties": {
+ "address": {
+ "description": "Address of this site contact.",
+ "type": "string"
+ },
+ "contactType": {
+ "description": "Site contact type.",
+ "enum": [
+ "SALES_PERSON",
+ "TRAFFICKER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "email": {
+ "description": "Email address of this site contact. This is a required field.",
+ "type": "string"
+ },
+ "firstName": {
+ "description": "First name of this site contact.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this site contact. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastName": {
+ "description": "Last name of this site contact.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "Primary phone number of this site contact.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title or designation of this site contact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSettings": {
+ "description": "Site Settings",
+ "id": "SiteSettings",
+ "properties": {
+ "activeViewOptOut": {
+ "description": "Whether active view creatives are disabled for this site.",
+ "type": "boolean"
+ },
+ "adBlockingOptOut": {
+ "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.",
+ "type": "boolean"
+ },
+ "disableNewCookie": {
+ "description": "Whether new cookies are disabled for this site.",
+ "type": "boolean"
+ },
+ "tagSetting": {
+ "$ref": "TagSetting",
+ "description": "Configuration settings for dynamic and image floodlight tags."
+ },
+ "videoActiveViewOptOutTemplate": {
+ "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
+ "type": "boolean"
+ },
+ "vpaidAdapterChoiceTemplate": {
+ "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
+ "enum": [
+ "DEFAULT",
+ "FLASH",
+ "HTML5",
+ "BOTH"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SiteSkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SiteTranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "SiteTranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SiteVideoSettings": {
+ "description": "Video Settings",
+ "id": "SiteVideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "SiteCompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this site."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".",
+ "type": "string"
+ },
+ "obaEnabled": {
+ "description": "Whether OBA icons are enabled for this placement.",
+ "type": "boolean"
+ },
+ "obaSettings": {
+ "$ref": "ObaIcon",
+ "description": "Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site."
+ },
+ "orientation": {
+ "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SiteSkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site."
+ },
+ "transcodeSettings": {
+ "$ref": "SiteTranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site."
+ }
+ },
+ "type": "object"
+ },
+ "SitesListResponse": {
+ "description": "Site List Response",
+ "id": "SitesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "sites": {
+ "description": "Site collection.",
+ "items": {
+ "$ref": "Site"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Size": {
+ "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
+ "id": "Size",
+ "properties": {
+ "height": {
+ "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "iab": {
+ "description": "IAB standard size. This is a read-only, auto-generated field.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this size. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SizesListResponse": {
+ "description": "Size List Response",
+ "id": "SizesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
+ "type": "string"
+ },
+ "sizes": {
+ "description": "Size collection.",
+ "items": {
+ "$ref": "Size"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SkippableSetting": {
+ "description": "Skippable Settings",
+ "id": "SkippableSetting",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
+ "type": "string"
+ },
+ "progressOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true."
+ },
+ "skipOffset": {
+ "$ref": "VideoOffset",
+ "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
+ },
+ "skippable": {
+ "description": "Whether the user can skip creatives served to this placement.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SortedDimension": {
+ "description": "Represents a sorted dimension.",
+ "id": "SortedDimension",
+ "properties": {
+ "kind": {
+ "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the dimension.",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "An optional sort order for the dimension column.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Subaccount": {
+ "description": "Contains properties of a Campaign Manager subaccount.",
+ "id": "Subaccount",
+ "properties": {
+ "accountId": {
+ "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "availablePermissionIds": {
+ "description": "IDs of the available user role permissions for this subaccount.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of this subaccount. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubaccountsListResponse": {
+ "description": "Subaccount List Response",
+ "id": "SubaccountsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "subaccounts": {
+ "description": "Subaccount collection.",
+ "items": {
+ "$ref": "Subaccount"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagData": {
+ "description": "Placement Tag Data",
+ "id": "TagData",
+ "properties": {
+ "adId": {
+ "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickTag": {
+ "description": "Tag string to record a click.",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
+ "format": "int64",
+ "type": "string"
+ },
+ "format": {
+ "description": "TagData tag format of this tag.",
+ "enum": [
+ "PLACEMENT_TAG_STANDARD",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_IFRAME_ILAYER",
+ "PLACEMENT_TAG_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
+ "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
+ "PLACEMENT_TAG_CLICK_COMMANDS",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
+ "PLACEMENT_TAG_TRACKING",
+ "PLACEMENT_TAG_TRACKING_IFRAME",
+ "PLACEMENT_TAG_TRACKING_JAVASCRIPT",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "impressionTag": {
+ "description": "Tag string for serving an ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSetting": {
+ "description": "Tag Settings",
+ "id": "TagSetting",
+ "properties": {
+ "additionalKeyValues": {
+ "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.",
+ "type": "string"
+ },
+ "includeClickThroughUrls": {
+ "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.",
+ "type": "boolean"
+ },
+ "includeClickTracking": {
+ "description": "Whether click-tracking string should be included in the tags.",
+ "type": "boolean"
+ },
+ "keywordOption": {
+ "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
+ "enum": [
+ "PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
+ "IGNORE",
+ "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagSettings": {
+ "description": "Dynamic and Image Tag Settings.",
+ "id": "TagSettings",
+ "properties": {
+ "dynamicTagEnabled": {
+ "description": "Whether dynamic floodlight tags are enabled.",
+ "type": "boolean"
+ },
+ "imageTagEnabled": {
+ "description": "Whether image tags are enabled.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "TargetWindow": {
+ "description": "Target Window.",
+ "id": "TargetWindow",
+ "properties": {
+ "customHtml": {
+ "description": "User-entered value.",
+ "type": "string"
+ },
+ "targetWindowOption": {
+ "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
+ "enum": [
+ "NEW_WINDOW",
+ "CURRENT_WINDOW",
+ "CUSTOM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetableRemarketingList": {
+ "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
+ "id": "TargetableRemarketingList",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether this targetable remarketing list is active.",
+ "type": "boolean"
+ },
+ "advertiserId": {
+ "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser."
+ },
+ "description": {
+ "description": "Targetable remarketing list description.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Targetable remarketing list ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
+ "type": "string"
+ },
+ "lifeSpan": {
+ "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSize": {
+ "description": "Number of users currently in the list. This is a read-only field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "listSource": {
+ "description": "Product from which this targetable remarketing list was originated.",
+ "enum": [
+ "REMARKETING_LIST_SOURCE_OTHER",
+ "REMARKETING_LIST_SOURCE_ADX",
+ "REMARKETING_LIST_SOURCE_DFP",
+ "REMARKETING_LIST_SOURCE_XFP",
+ "REMARKETING_LIST_SOURCE_DFA",
+ "REMARKETING_LIST_SOURCE_GA",
+ "REMARKETING_LIST_SOURCE_YOUTUBE",
+ "REMARKETING_LIST_SOURCE_DBM",
+ "REMARKETING_LIST_SOURCE_GPLUS",
+ "REMARKETING_LIST_SOURCE_DMP",
+ "REMARKETING_LIST_SOURCE_PLAY_STORE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetableRemarketingListsListResponse": {
+ "description": "Targetable remarketing list response",
+ "id": "TargetableRemarketingListsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetableRemarketingLists": {
+ "description": "Targetable remarketing list collection.",
+ "items": {
+ "$ref": "TargetableRemarketingList"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplate": {
+ "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.",
+ "id": "TargetingTemplate",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "advertiserIdDimensionValue": {
+ "$ref": "DimensionValue",
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
+ },
+ "dayPartTargeting": {
+ "$ref": "DayPartTargeting",
+ "description": "Time and day targeting criteria."
+ },
+ "geoTargeting": {
+ "$ref": "GeoTargeting",
+ "description": "Geographical targeting criteria."
+ },
+ "id": {
+ "description": "ID of this targeting template. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "keyValueTargetingExpression": {
+ "$ref": "KeyValueTargetingExpression",
+ "description": "Key-value targeting criteria."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "LanguageTargeting",
+ "description": "Language targeting criteria."
+ },
+ "listTargetingExpression": {
+ "$ref": "ListTargetingExpression",
+ "description": "Remarketing list targeting criteria."
+ },
+ "name": {
+ "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.",
+ "type": "string"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
+ "format": "int64",
+ "type": "string"
+ },
+ "technologyTargeting": {
+ "$ref": "TechnologyTargeting",
+ "description": "Technology platform targeting criteria."
+ }
+ },
+ "type": "object"
+ },
+ "TargetingTemplatesListResponse": {
+ "description": "Targeting Template List Response",
+ "id": "TargetingTemplatesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "targetingTemplates": {
+ "description": "Targeting template collection.",
+ "items": {
+ "$ref": "TargetingTemplate"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TechnologyTargeting": {
+ "description": "Technology Targeting.",
+ "id": "TechnologyTargeting",
+ "properties": {
+ "browsers": {
+ "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "Browser"
+ },
+ "type": "array"
+ },
+ "connectionTypes": {
+ "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "ConnectionType"
+ },
+ "type": "array"
+ },
+ "mobileCarriers": {
+ "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
+ "items": {
+ "$ref": "MobileCarrier"
+ },
+ "type": "array"
+ },
+ "operatingSystemVersions": {
+ "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
+ "items": {
+ "$ref": "OperatingSystemVersion"
+ },
+ "type": "array"
+ },
+ "operatingSystems": {
+ "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
+ "items": {
+ "$ref": "OperatingSystem"
+ },
+ "type": "array"
+ },
+ "platformTypes": {
+ "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
+ "items": {
+ "$ref": "PlatformType"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyAuthenticationToken": {
+ "description": "Third Party Authentication Token",
+ "id": "ThirdPartyAuthenticationToken",
+ "properties": {
+ "name": {
+ "description": "Name of the third-party authentication token.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ThirdPartyTrackingUrl": {
+ "description": "Third-party Tracking URL.",
+ "id": "ThirdPartyTrackingUrl",
+ "properties": {
+ "thirdPartyUrlType": {
+ "description": "Third-party URL type for in-stream video and in-stream audio creatives.",
+ "enum": [
+ "IMPRESSION",
+ "CLICK_TRACKING",
+ "VIDEO_START",
+ "VIDEO_FIRST_QUARTILE",
+ "VIDEO_MIDPOINT",
+ "VIDEO_THIRD_QUARTILE",
+ "VIDEO_COMPLETE",
+ "VIDEO_MUTE",
+ "VIDEO_PAUSE",
+ "VIDEO_REWIND",
+ "VIDEO_FULLSCREEN",
+ "VIDEO_STOP",
+ "VIDEO_CUSTOM",
+ "SURVEY",
+ "RICH_MEDIA_IMPRESSION",
+ "RICH_MEDIA_RM_IMPRESSION",
+ "RICH_MEDIA_BACKUP_IMPRESSION",
+ "VIDEO_SKIP",
+ "VIDEO_PROGRESS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the specified third-party URL type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TranscodeSetting": {
+ "description": "Transcode Settings",
+ "id": "TranscodeSetting",
+ "properties": {
+ "enabledVideoFormats": {
+ "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UniversalAdId": {
+ "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
+ "id": "UniversalAdId",
+ "properties": {
+ "registry": {
+ "description": "Registry used for the Ad ID value.",
+ "enum": [
+ "OTHER",
+ "AD_ID_OFFICIAL",
+ "CLEARCAST",
+ "DCM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserDefinedVariableConfiguration": {
+ "description": "User Defined Variable configuration.",
+ "id": "UserDefinedVariableConfiguration",
+ "properties": {
+ "dataType": {
+ "description": "Data type for the variable. This is a required field.",
+ "enum": [
+ "STRING",
+ "NUMBER"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "reportName": {
+ "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".",
+ "type": "string"
+ },
+ "variableType": {
+ "description": "Variable name in the tag. This is a required field.",
+ "enum": [
+ "U1",
+ "U2",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U20",
+ "U21",
+ "U22",
+ "U23",
+ "U24",
+ "U25",
+ "U26",
+ "U27",
+ "U28",
+ "U29",
+ "U30",
+ "U31",
+ "U32",
+ "U33",
+ "U34",
+ "U35",
+ "U36",
+ "U37",
+ "U38",
+ "U39",
+ "U40",
+ "U41",
+ "U42",
+ "U43",
+ "U44",
+ "U45",
+ "U46",
+ "U47",
+ "U48",
+ "U49",
+ "U50",
+ "U51",
+ "U52",
+ "U53",
+ "U54",
+ "U55",
+ "U56",
+ "U57",
+ "U58",
+ "U59",
+ "U60",
+ "U61",
+ "U62",
+ "U63",
+ "U64",
+ "U65",
+ "U66",
+ "U67",
+ "U68",
+ "U69",
+ "U70",
+ "U71",
+ "U72",
+ "U73",
+ "U74",
+ "U75",
+ "U76",
+ "U77",
+ "U78",
+ "U79",
+ "U80",
+ "U81",
+ "U82",
+ "U83",
+ "U84",
+ "U85",
+ "U86",
+ "U87",
+ "U88",
+ "U89",
+ "U90",
+ "U91",
+ "U92",
+ "U93",
+ "U94",
+ "U95",
+ "U96",
+ "U97",
+ "U98",
+ "U99",
+ "U100"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfile": {
+ "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
+ "id": "UserProfile",
+ "properties": {
+ "accountId": {
+ "description": "The account ID to which this profile belongs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "accountName": {
+ "description": "The account name this profile belongs to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The unique ID of the user profile.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountId": {
+ "description": "The sub account ID this profile belongs to if applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "subAccountName": {
+ "description": "The sub account name this profile belongs to if applicable.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "The user name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserProfileList": {
+ "description": "Represents the list of user profiles.",
+ "id": "UserProfileList",
+ "properties": {
+ "etag": {
+ "description": "Etag of this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The user profiles returned in this response.",
+ "items": {
+ "$ref": "UserProfile"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRole": {
+ "description": "Contains properties of auser role, which is used to manage user access.",
+ "id": "UserRole",
+ "properties": {
+ "accountId": {
+ "description": "Account ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultUserRole": {
+ "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "ID of this user role. This is a read-only, auto-generated field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
+ "type": "string"
+ },
+ "parentUserRoleId": {
+ "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "List of permissions associated with this user role.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ },
+ "subaccountId": {
+ "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermission": {
+ "description": "Contains properties of a user role permission.",
+ "id": "UserRolePermission",
+ "properties": {
+ "availability": {
+ "description": "Levels of availability for a user role permission.",
+ "enum": [
+ "NOT_AVAILABLE_BY_DEFAULT",
+ "ACCOUNT_BY_DEFAULT",
+ "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
+ "ACCOUNT_ALWAYS",
+ "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
+ "USER_PROFILE_ONLY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission.",
+ "type": "string"
+ },
+ "permissionGroupId": {
+ "description": "ID of the permission group that this user role permission belongs to.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroup": {
+ "description": "Represents a grouping of related user role permissions.",
+ "id": "UserRolePermissionGroup",
+ "properties": {
+ "id": {
+ "description": "ID of this user role permission.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this user role permission group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionGroupsListResponse": {
+ "description": "User Role Permission Group List Response",
+ "id": "UserRolePermissionGroupsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissionGroups": {
+ "description": "User role permission group collection.",
+ "items": {
+ "$ref": "UserRolePermissionGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolePermissionsListResponse": {
+ "description": "User Role Permission List Response",
+ "id": "UserRolePermissionsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
+ "type": "string"
+ },
+ "userRolePermissions": {
+ "description": "User role permission collection.",
+ "items": {
+ "$ref": "UserRolePermission"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserRolesListResponse": {
+ "description": "User Role List Response",
+ "id": "UserRolesListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to be used for the next list operation.",
+ "type": "string"
+ },
+ "userRoles": {
+ "description": "User role collection.",
+ "items": {
+ "$ref": "UserRole"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormat": {
+ "description": "Contains information about supported video formats.",
+ "id": "VideoFormat",
+ "properties": {
+ "fileType": {
+ "description": "File type of the video format.",
+ "enum": [
+ "FLV",
+ "THREEGPP",
+ "MP4",
+ "WEBM",
+ "M3U8"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the video format.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
+ "type": "string"
+ },
+ "resolution": {
+ "$ref": "Size",
+ "description": "The resolution of this video format."
+ },
+ "targetBitRate": {
+ "description": "The target bit rate of this video format.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoFormatsListResponse": {
+ "description": "Video Format List Response",
+ "id": "VideoFormatsListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".",
+ "type": "string"
+ },
+ "videoFormats": {
+ "description": "Video format collection.",
+ "items": {
+ "$ref": "VideoFormat"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoOffset": {
+ "description": "Video Offset",
+ "id": "VideoOffset",
+ "properties": {
+ "offsetPercentage": {
+ "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetSeconds": {
+ "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VideoSettings": {
+ "description": "Video Settings",
+ "id": "VideoSettings",
+ "properties": {
+ "companionSettings": {
+ "$ref": "CompanionSetting",
+ "description": "Settings for the companion creatives of video creatives served to this placement."
+ },
+ "durationSeconds": {
+ "description": "Duration of a video placement in seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
+ "type": "string"
+ },
+ "obaEnabled": {
+ "description": "Whether OBA icons are enabled for this placement.",
+ "type": "boolean"
+ },
+ "obaSettings": {
+ "$ref": "ObaIcon",
+ "description": "Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden."
+ },
+ "orientation": {
+ "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
+ "enum": [
+ "ANY",
+ "LANDSCAPE",
+ "PORTRAIT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "skippableSettings": {
+ "$ref": "SkippableSetting",
+ "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden."
+ },
+ "transcodeSettings": {
+ "$ref": "TranscodeSetting",
+ "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Campaign Manager 360 API",
+ "version": "v3.5"
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json
index dd9afb6f02f..5dd98531129 100644
--- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json
+++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json
@@ -1,3856 +1,3663 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/doubleclickbidmanager": {
- "description": "View and manage your reports in DoubleClick Bid Manager"
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/doubleclickbidmanager": {
+ "description": "View and manage your reports in DoubleClick Bid Manager"
+ }
+ }
+ }
+ },
+ "basePath": "/doubleclickbidmanager/v1.1/",
+ "baseUrl": "https://doubleclickbidmanager.googleapis.com/doubleclickbidmanager/v1.1/",
+ "batchPath": "batch",
+ "canonicalName": "DoubleClick Bid Manager",
+ "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/bid-manager/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "doubleclickbidmanager:v1.1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
+ "name": "doubleclickbidmanager",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "queries": {
+ "methods": {
+ "createquery": {
+ "description": "Creates a query.",
+ "flatPath": "query",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.queries.createquery",
+ "parameterOrder": [],
+ "parameters": {
+ "asynchronous": {
+ "default": "false",
+ "description": "If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "query",
+ "request": {
+ "$ref": "Query"
+ },
+ "response": {
+ "$ref": "Query"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "deletequery": {
+ "description": "Deletes a stored query as well as the associated stored reports.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "DELETE",
+ "id": "doubleclickbidmanager.queries.deletequery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "query/{queryId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "getquery": {
+ "description": "Retrieves a stored query.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.queries.getquery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
+ },
+ "path": "query/{queryId}",
+ "response": {
+ "$ref": "Query"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "listqueries": {
+ "description": "Retrieves stored queries.",
+ "flatPath": "queries",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.queries.listqueries",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional pagination token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "queries",
+ "response": {
+ "$ref": "ListQueriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "runquery": {
+ "description": "Runs a stored query to generate a report.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.queries.runquery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "asynchronous": {
+ "default": "false",
+ "description": "If true, tries to run the query asynchronously.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "queryId": {
+ "description": "Query ID to run.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "query/{queryId}",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "listreports": {
+ "description": "Retrieves stored reports.",
+ "flatPath": "queries/{queryId}/reports",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.reports.listreports",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional pagination token.",
+ "location": "query",
+ "type": "string"
+ },
+ "queryId": {
+ "description": "Query ID with which the reports are associated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "queries/{queryId}/reports",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210524",
+ "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
+ "schemas": {
+ "ChannelGrouping": {
+ "description": "A channel grouping defines a set of rules that can be used to categorize events in a path report.",
+ "id": "ChannelGrouping",
+ "properties": {
+ "fallbackName": {
+ "description": "The name to apply to an event that does not match any of the rules in the channel grouping.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Channel Grouping name.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DisjunctiveMatchStatement": {
+ "description": "DisjunctiveMatchStatement that OR's all contained filters.",
+ "id": "DisjunctiveMatchStatement",
+ "properties": {
+ "eventFilters": {
+ "description": "Filters. There is a limit of 100 filters that can be set per disjunctive match statement.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
}
+ },
+ "type": "object"
},
- "basePath": "/doubleclickbidmanager/v1.1/",
- "baseUrl": "https://doubleclickbidmanager.googleapis.com/doubleclickbidmanager/v1.1/",
- "batchPath": "batch",
- "canonicalName": "DoubleClick Bid Manager",
- "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.",
- "discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/bid-manager/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "EventFilter": {
+ "description": "Defines the type of filter to be applied to the path, a DV360 event dimension filter.",
+ "id": "EventFilter",
+ "properties": {
+ "dimensionFilter": {
+ "$ref": "PathQueryOptionsFilter",
+ "description": "Filter on a dimension."
+ }
+ },
+ "type": "object"
+ },
+ "FilterPair": {
+ "description": "Filter used to match traffic data in your report.",
+ "id": "FilterPair",
+ "properties": {
+ "type": {
+ "description": "Filter type.",
+ "enum": [
+ "FILTER_UNKNOWN",
+ "FILTER_DATE",
+ "FILTER_DAY_OF_WEEK",
+ "FILTER_WEEK",
+ "FILTER_MONTH",
+ "FILTER_YEAR",
+ "FILTER_TIME_OF_DAY",
+ "FILTER_CONVERSION_DELAY",
+ "FILTER_CREATIVE_ID",
+ "FILTER_CREATIVE_SIZE",
+ "FILTER_CREATIVE_TYPE",
+ "FILTER_EXCHANGE_ID",
+ "FILTER_AD_POSITION",
+ "FILTER_PUBLIC_INVENTORY",
+ "FILTER_INVENTORY_SOURCE",
+ "FILTER_CITY",
+ "FILTER_REGION",
+ "FILTER_DMA",
+ "FILTER_COUNTRY",
+ "FILTER_SITE_ID",
+ "FILTER_CHANNEL_ID",
+ "FILTER_PARTNER",
+ "FILTER_ADVERTISER",
+ "FILTER_INSERTION_ORDER",
+ "FILTER_LINE_ITEM",
+ "FILTER_PARTNER_CURRENCY",
+ "FILTER_ADVERTISER_CURRENCY",
+ "FILTER_ADVERTISER_TIMEZONE",
+ "FILTER_LINE_ITEM_TYPE",
+ "FILTER_USER_LIST",
+ "FILTER_USER_LIST_FIRST_PARTY",
+ "FILTER_USER_LIST_THIRD_PARTY",
+ "FILTER_TARGETED_USER_LIST",
+ "FILTER_DATA_PROVIDER",
+ "FILTER_ORDER_ID",
+ "FILTER_VIDEO_PLAYER_SIZE",
+ "FILTER_VIDEO_DURATION_SECONDS",
+ "FILTER_KEYWORD",
+ "FILTER_PAGE_CATEGORY",
+ "FILTER_CAMPAIGN_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
+ "FILTER_OS",
+ "FILTER_BROWSER",
+ "FILTER_CARRIER",
+ "FILTER_SITE_LANGUAGE",
+ "FILTER_INVENTORY_FORMAT",
+ "FILTER_ZIP_CODE",
+ "FILTER_VIDEO_RATING_TIER",
+ "FILTER_VIDEO_FORMAT_SUPPORT",
+ "FILTER_VIDEO_SKIPPABLE_SUPPORT",
+ "FILTER_VIDEO_CREATIVE_DURATION",
+ "FILTER_PAGE_LAYOUT",
+ "FILTER_VIDEO_AD_POSITION_IN_STREAM",
+ "FILTER_AGE",
+ "FILTER_GENDER",
+ "FILTER_QUARTER",
+ "FILTER_TRUEVIEW_CONVERSION_TYPE",
+ "FILTER_MOBILE_GEO",
+ "FILTER_MRAID_SUPPORT",
+ "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
+ "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
+ "FILTER_NIELSEN_COUNTRY_CODE",
+ "FILTER_NIELSEN_DEVICE_ID",
+ "FILTER_NIELSEN_GENDER",
+ "FILTER_NIELSEN_AGE",
+ "FILTER_INVENTORY_SOURCE_TYPE",
+ "FILTER_CREATIVE_WIDTH",
+ "FILTER_CREATIVE_HEIGHT",
+ "FILTER_DFP_ORDER_ID",
+ "FILTER_TRUEVIEW_AGE",
+ "FILTER_TRUEVIEW_GENDER",
+ "FILTER_TRUEVIEW_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_INTEREST",
+ "FILTER_TRUEVIEW_AD_GROUP_ID",
+ "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
+ "FILTER_TRUEVIEW_IAR_LANGUAGE",
+ "FILTER_TRUEVIEW_IAR_GENDER",
+ "FILTER_TRUEVIEW_IAR_AGE",
+ "FILTER_TRUEVIEW_IAR_CATEGORY",
+ "FILTER_TRUEVIEW_IAR_COUNTRY",
+ "FILTER_TRUEVIEW_IAR_CITY",
+ "FILTER_TRUEVIEW_IAR_REGION",
+ "FILTER_TRUEVIEW_IAR_ZIPCODE",
+ "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_IAR_INTEREST",
+ "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
+ "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
+ "FILTER_TRUEVIEW_CATEGORY",
+ "FILTER_TRUEVIEW_KEYWORD",
+ "FILTER_TRUEVIEW_PLACEMENT",
+ "FILTER_TRUEVIEW_URL",
+ "FILTER_TRUEVIEW_COUNTRY",
+ "FILTER_TRUEVIEW_REGION",
+ "FILTER_TRUEVIEW_CITY",
+ "FILTER_TRUEVIEW_DMA",
+ "FILTER_TRUEVIEW_ZIPCODE",
+ "FILTER_NOT_SUPPORTED",
+ "FILTER_MEDIA_PLAN",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
+ "FILTER_SKIPPABLE_SUPPORT",
+ "FILTER_COMPANION_CREATIVE_ID",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
+ "FILTER_FLOODLIGHT_ACTIVITY_ID",
+ "FILTER_DEVICE_MODEL",
+ "FILTER_DEVICE_MAKE",
+ "FILTER_DEVICE_TYPE",
+ "FILTER_CREATIVE_ATTRIBUTE",
+ "FILTER_INVENTORY_COMMITMENT_TYPE",
+ "FILTER_INVENTORY_RATE_TYPE",
+ "FILTER_INVENTORY_DELIVERY_METHOD",
+ "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
+ "FILTER_AUTHORIZED_SELLER_STATE",
+ "FILTER_VIDEO_DURATION_SECONDS_RANGE",
+ "FILTER_PARTNER_NAME",
+ "FILTER_PARTNER_STATUS",
+ "FILTER_ADVERTISER_NAME",
+ "FILTER_ADVERTISER_INTEGRATION_CODE",
+ "FILTER_ADVERTISER_INTEGRATION_STATUS",
+ "FILTER_CARRIER_NAME",
+ "FILTER_CHANNEL_NAME",
+ "FILTER_CITY_NAME",
+ "FILTER_COMPANION_CREATIVE_NAME",
+ "FILTER_USER_LIST_FIRST_PARTY_NAME",
+ "FILTER_USER_LIST_THIRD_PARTY_NAME",
+ "FILTER_NIELSEN_RESTATEMENT_DATE",
+ "FILTER_NIELSEN_DATE_RANGE",
+ "FILTER_INSERTION_ORDER_NAME",
+ "FILTER_REGION_NAME",
+ "FILTER_DMA_NAME",
+ "FILTER_TRUEVIEW_IAR_REGION_NAME",
+ "FILTER_TRUEVIEW_DMA_NAME",
+ "FILTER_TRUEVIEW_REGION_NAME",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
+ "FILTER_AD_TYPE",
+ "FILTER_ALGORITHM",
+ "FILTER_ALGORITHM_ID",
+ "FILTER_AMP_PAGE_REQUEST",
+ "FILTER_ANONYMOUS_INVENTORY_MODELING",
+ "FILTER_APP_URL",
+ "FILTER_APP_URL_EXCLUDED",
+ "FILTER_ATTRIBUTED_USERLIST",
+ "FILTER_ATTRIBUTED_USERLIST_COST",
+ "FILTER_ATTRIBUTED_USERLIST_TYPE",
+ "FILTER_ATTRIBUTION_MODEL",
+ "FILTER_AUDIENCE_LIST",
+ "FILTER_AUDIENCE_LIST_COST",
+ "FILTER_AUDIENCE_LIST_TYPE",
+ "FILTER_AUDIENCE_NAME",
+ "FILTER_AUDIENCE_TYPE",
+ "FILTER_BILLABLE_OUTCOME",
+ "FILTER_BRAND_LIFT_TYPE",
+ "FILTER_CHANNEL_TYPE",
+ "FILTER_CM_PLACEMENT_ID",
+ "FILTER_CONVERSION_SOURCE",
+ "FILTER_CONVERSION_SOURCE_ID",
+ "FILTER_COUNTRY_ID",
+ "FILTER_CREATIVE",
+ "FILTER_CREATIVE_ASSET",
+ "FILTER_CREATIVE_INTEGRATION_CODE",
+ "FILTER_CREATIVE_RENDERED_IN_AMP",
+ "FILTER_CREATIVE_SOURCE",
+ "FILTER_CREATIVE_STATUS",
+ "FILTER_DATA_PROVIDER_NAME",
+ "FILTER_DETAILED_DEMOGRAPHICS",
+ "FILTER_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_DEVICE",
+ "FILTER_GAM_INSERTION_ORDER",
+ "FILTER_GAM_LINE_ITEM",
+ "FILTER_GAM_LINE_ITEM_ID",
+ "FILTER_DIGITAL_CONTENT_LABEL",
+ "FILTER_DOMAIN",
+ "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
+ "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
+ "FILTER_EXCHANGE",
+ "FILTER_EXCHANGE_CODE",
+ "FILTER_EXTENSION",
+ "FILTER_EXTENSION_STATUS",
+ "FILTER_EXTENSION_TYPE",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_FLOODLIGHT_ACTIVITY",
+ "FILTER_FORMAT",
+ "FILTER_GMAIL_AGE",
+ "FILTER_GMAIL_CITY",
+ "FILTER_GMAIL_COUNTRY",
+ "FILTER_GMAIL_COUNTRY_NAME",
+ "FILTER_GMAIL_DEVICE_TYPE",
+ "FILTER_GMAIL_DEVICE_TYPE_NAME",
+ "FILTER_GMAIL_GENDER",
+ "FILTER_GMAIL_REGION",
+ "FILTER_GMAIL_REMARKETING_LIST",
+ "FILTER_HOUSEHOLD_INCOME",
+ "FILTER_IMPRESSION_COUNTING_METHOD",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
+ "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
+ "FILTER_INSERTION_ORDER_STATUS",
+ "FILTER_INTEREST",
+ "FILTER_INVENTORY_SOURCE_GROUP",
+ "FILTER_INVENTORY_SOURCE_GROUP_ID",
+ "FILTER_INVENTORY_SOURCE_ID",
+ "FILTER_INVENTORY_SOURCE_NAME",
+ "FILTER_LIFE_EVENT",
+ "FILTER_LIFE_EVENTS",
+ "FILTER_LINE_ITEM_INTEGRATION_CODE",
+ "FILTER_LINE_ITEM_NAME",
+ "FILTER_LINE_ITEM_STATUS",
+ "FILTER_MATCH_RATIO",
+ "FILTER_MEASUREMENT_SOURCE",
+ "FILTER_MEDIA_PLAN_NAME",
+ "FILTER_PARENTAL_STATUS",
+ "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
+ "FILTER_PLATFORM",
+ "FILTER_PLAYBACK_METHOD",
+ "FILTER_POSITION_IN_CONTENT",
+ "FILTER_PUBLISHER_PROPERTY",
+ "FILTER_PUBLISHER_PROPERTY_ID",
+ "FILTER_PUBLISHER_PROPERTY_SECTION",
+ "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
+ "FILTER_REFUND_REASON",
+ "FILTER_REMARKETING_LIST",
+ "FILTER_REWARDED",
+ "FILTER_SENSITIVE_CATEGORY",
+ "FILTER_SERVED_PIXEL_DENSITY",
+ "FILTER_TARGETED_DATA_PROVIDERS",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_TRUEVIEW_AD",
+ "FILTER_TRUEVIEW_AD_GROUP",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
+ "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
+ "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
+ "FILTER_VARIANT_ID",
+ "FILTER_VARIANT_NAME",
+ "FILTER_VARIANT_VERSION",
+ "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
+ "FILTER_VERIFICATION_VIDEO_POSITION",
+ "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
+ "FILTER_VIDEO_CONTINUOUS_PLAY",
+ "FILTER_VIDEO_DURATION",
+ "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
+ "FILTER_YOUTUBE_AD_VIDEO",
+ "FILTER_YOUTUBE_AD_VIDEO_ID",
+ "FILTER_YOUTUBE_CHANNEL",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
+ "FILTER_YOUTUBE_VIDEO",
+ "FILTER_ZIP_POSTAL_CODE",
+ "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
+ "FILTER_TRUEVIEW_PLACEMENT_ID",
+ "FILTER_PATH_PATTERN_ID",
+ "FILTER_PATH_EVENT_INDEX",
+ "FILTER_EVENT_TYPE",
+ "FILTER_CHANNEL_GROUPING",
+ "FILTER_OM_SDK_AVAILABLE",
+ "FILTER_DATA_SOURCE",
+ "FILTER_CM360_PLACEMENT_ID",
+ "FILTER_TRUEVIEW_CLICK_TYPE_NAME",
+ "FILTER_TRUEVIEW_AD_TYPE_NAME",
+ "FILTER_VIDEO_CONTENT_DURATION",
+ "FILTER_MATCHED_GENRE_TARGET",
+ "FILTER_VIDEO_CONTENT_LIVE_STREAM",
+ "FILTER_BUDGET_SEGMENT_TYPE",
+ "FILTER_BUDGET_SEGMENT_BUDGET",
+ "FILTER_BUDGET_SEGMENT_START_DATE",
+ "FILTER_BUDGET_SEGMENT_END_DATE",
+ "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE",
+ "FILTER_LINE_ITEM_BUDGET",
+ "FILTER_LINE_ITEM_START_DATE",
+ "FILTER_LINE_ITEM_END_DATE",
+ "FILTER_INSERTION_ORDER_GOAL_TYPE",
+ "FILTER_LINE_ITEM_PACING_PERCENTAGE",
+ "FILTER_INSERTION_ORDER_GOAL_VALUE",
+ "FILTER_OMID_CAPABLE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Filter value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListQueriesResponse": {
+ "description": "List queries response.",
+ "id": "ListQueriesResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Next page's pagination token if one exists.",
+ "type": "string"
+ },
+ "queries": {
+ "description": "Retrieved queries.",
+ "items": {
+ "$ref": "Query"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListReportsResponse": {
+ "description": "List reports response.",
+ "id": "ListReportsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Next page's pagination token if one exists.",
+ "type": "string"
+ },
+ "reports": {
+ "description": "Retrieved reports.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "id": "doubleclickbidmanager:v1.1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
- "name": "doubleclickbidmanager",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
+ "Options": {
+ "description": "Additional query options.",
+ "id": "Options",
+ "properties": {
+ "includeOnlyTargetedUserLists": {
+ "description": "Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.",
+ "type": "boolean"
+ },
+ "pathQueryOptions": {
+ "$ref": "PathQueryOptions",
+ "description": "Options that contain Path Filters and Custom Channel Groupings."
+ }
+ },
+ "type": "object"
+ },
+ "Parameters": {
+ "description": "Parameters of a query or report.",
+ "id": "Parameters",
+ "properties": {
+ "filters": {
+ "description": "Filters used to match traffic data in your report.",
+ "items": {
+ "$ref": "FilterPair"
+ },
+ "type": "array"
+ },
+ "groupBys": {
+ "description": "Data is grouped by the filters listed in this field.",
+ "items": {
"enum": [
- "1",
- "2"
+ "FILTER_UNKNOWN",
+ "FILTER_DATE",
+ "FILTER_DAY_OF_WEEK",
+ "FILTER_WEEK",
+ "FILTER_MONTH",
+ "FILTER_YEAR",
+ "FILTER_TIME_OF_DAY",
+ "FILTER_CONVERSION_DELAY",
+ "FILTER_CREATIVE_ID",
+ "FILTER_CREATIVE_SIZE",
+ "FILTER_CREATIVE_TYPE",
+ "FILTER_EXCHANGE_ID",
+ "FILTER_AD_POSITION",
+ "FILTER_PUBLIC_INVENTORY",
+ "FILTER_INVENTORY_SOURCE",
+ "FILTER_CITY",
+ "FILTER_REGION",
+ "FILTER_DMA",
+ "FILTER_COUNTRY",
+ "FILTER_SITE_ID",
+ "FILTER_CHANNEL_ID",
+ "FILTER_PARTNER",
+ "FILTER_ADVERTISER",
+ "FILTER_INSERTION_ORDER",
+ "FILTER_LINE_ITEM",
+ "FILTER_PARTNER_CURRENCY",
+ "FILTER_ADVERTISER_CURRENCY",
+ "FILTER_ADVERTISER_TIMEZONE",
+ "FILTER_LINE_ITEM_TYPE",
+ "FILTER_USER_LIST",
+ "FILTER_USER_LIST_FIRST_PARTY",
+ "FILTER_USER_LIST_THIRD_PARTY",
+ "FILTER_TARGETED_USER_LIST",
+ "FILTER_DATA_PROVIDER",
+ "FILTER_ORDER_ID",
+ "FILTER_VIDEO_PLAYER_SIZE",
+ "FILTER_VIDEO_DURATION_SECONDS",
+ "FILTER_KEYWORD",
+ "FILTER_PAGE_CATEGORY",
+ "FILTER_CAMPAIGN_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
+ "FILTER_OS",
+ "FILTER_BROWSER",
+ "FILTER_CARRIER",
+ "FILTER_SITE_LANGUAGE",
+ "FILTER_INVENTORY_FORMAT",
+ "FILTER_ZIP_CODE",
+ "FILTER_VIDEO_RATING_TIER",
+ "FILTER_VIDEO_FORMAT_SUPPORT",
+ "FILTER_VIDEO_SKIPPABLE_SUPPORT",
+ "FILTER_VIDEO_CREATIVE_DURATION",
+ "FILTER_PAGE_LAYOUT",
+ "FILTER_VIDEO_AD_POSITION_IN_STREAM",
+ "FILTER_AGE",
+ "FILTER_GENDER",
+ "FILTER_QUARTER",
+ "FILTER_TRUEVIEW_CONVERSION_TYPE",
+ "FILTER_MOBILE_GEO",
+ "FILTER_MRAID_SUPPORT",
+ "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
+ "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
+ "FILTER_NIELSEN_COUNTRY_CODE",
+ "FILTER_NIELSEN_DEVICE_ID",
+ "FILTER_NIELSEN_GENDER",
+ "FILTER_NIELSEN_AGE",
+ "FILTER_INVENTORY_SOURCE_TYPE",
+ "FILTER_CREATIVE_WIDTH",
+ "FILTER_CREATIVE_HEIGHT",
+ "FILTER_DFP_ORDER_ID",
+ "FILTER_TRUEVIEW_AGE",
+ "FILTER_TRUEVIEW_GENDER",
+ "FILTER_TRUEVIEW_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_INTEREST",
+ "FILTER_TRUEVIEW_AD_GROUP_ID",
+ "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
+ "FILTER_TRUEVIEW_IAR_LANGUAGE",
+ "FILTER_TRUEVIEW_IAR_GENDER",
+ "FILTER_TRUEVIEW_IAR_AGE",
+ "FILTER_TRUEVIEW_IAR_CATEGORY",
+ "FILTER_TRUEVIEW_IAR_COUNTRY",
+ "FILTER_TRUEVIEW_IAR_CITY",
+ "FILTER_TRUEVIEW_IAR_REGION",
+ "FILTER_TRUEVIEW_IAR_ZIPCODE",
+ "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_IAR_INTEREST",
+ "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
+ "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
+ "FILTER_TRUEVIEW_CATEGORY",
+ "FILTER_TRUEVIEW_KEYWORD",
+ "FILTER_TRUEVIEW_PLACEMENT",
+ "FILTER_TRUEVIEW_URL",
+ "FILTER_TRUEVIEW_COUNTRY",
+ "FILTER_TRUEVIEW_REGION",
+ "FILTER_TRUEVIEW_CITY",
+ "FILTER_TRUEVIEW_DMA",
+ "FILTER_TRUEVIEW_ZIPCODE",
+ "FILTER_NOT_SUPPORTED",
+ "FILTER_MEDIA_PLAN",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
+ "FILTER_SKIPPABLE_SUPPORT",
+ "FILTER_COMPANION_CREATIVE_ID",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
+ "FILTER_FLOODLIGHT_ACTIVITY_ID",
+ "FILTER_DEVICE_MODEL",
+ "FILTER_DEVICE_MAKE",
+ "FILTER_DEVICE_TYPE",
+ "FILTER_CREATIVE_ATTRIBUTE",
+ "FILTER_INVENTORY_COMMITMENT_TYPE",
+ "FILTER_INVENTORY_RATE_TYPE",
+ "FILTER_INVENTORY_DELIVERY_METHOD",
+ "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
+ "FILTER_AUTHORIZED_SELLER_STATE",
+ "FILTER_VIDEO_DURATION_SECONDS_RANGE",
+ "FILTER_PARTNER_NAME",
+ "FILTER_PARTNER_STATUS",
+ "FILTER_ADVERTISER_NAME",
+ "FILTER_ADVERTISER_INTEGRATION_CODE",
+ "FILTER_ADVERTISER_INTEGRATION_STATUS",
+ "FILTER_CARRIER_NAME",
+ "FILTER_CHANNEL_NAME",
+ "FILTER_CITY_NAME",
+ "FILTER_COMPANION_CREATIVE_NAME",
+ "FILTER_USER_LIST_FIRST_PARTY_NAME",
+ "FILTER_USER_LIST_THIRD_PARTY_NAME",
+ "FILTER_NIELSEN_RESTATEMENT_DATE",
+ "FILTER_NIELSEN_DATE_RANGE",
+ "FILTER_INSERTION_ORDER_NAME",
+ "FILTER_REGION_NAME",
+ "FILTER_DMA_NAME",
+ "FILTER_TRUEVIEW_IAR_REGION_NAME",
+ "FILTER_TRUEVIEW_DMA_NAME",
+ "FILTER_TRUEVIEW_REGION_NAME",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
+ "FILTER_AD_TYPE",
+ "FILTER_ALGORITHM",
+ "FILTER_ALGORITHM_ID",
+ "FILTER_AMP_PAGE_REQUEST",
+ "FILTER_ANONYMOUS_INVENTORY_MODELING",
+ "FILTER_APP_URL",
+ "FILTER_APP_URL_EXCLUDED",
+ "FILTER_ATTRIBUTED_USERLIST",
+ "FILTER_ATTRIBUTED_USERLIST_COST",
+ "FILTER_ATTRIBUTED_USERLIST_TYPE",
+ "FILTER_ATTRIBUTION_MODEL",
+ "FILTER_AUDIENCE_LIST",
+ "FILTER_AUDIENCE_LIST_COST",
+ "FILTER_AUDIENCE_LIST_TYPE",
+ "FILTER_AUDIENCE_NAME",
+ "FILTER_AUDIENCE_TYPE",
+ "FILTER_BILLABLE_OUTCOME",
+ "FILTER_BRAND_LIFT_TYPE",
+ "FILTER_CHANNEL_TYPE",
+ "FILTER_CM_PLACEMENT_ID",
+ "FILTER_CONVERSION_SOURCE",
+ "FILTER_CONVERSION_SOURCE_ID",
+ "FILTER_COUNTRY_ID",
+ "FILTER_CREATIVE",
+ "FILTER_CREATIVE_ASSET",
+ "FILTER_CREATIVE_INTEGRATION_CODE",
+ "FILTER_CREATIVE_RENDERED_IN_AMP",
+ "FILTER_CREATIVE_SOURCE",
+ "FILTER_CREATIVE_STATUS",
+ "FILTER_DATA_PROVIDER_NAME",
+ "FILTER_DETAILED_DEMOGRAPHICS",
+ "FILTER_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_DEVICE",
+ "FILTER_GAM_INSERTION_ORDER",
+ "FILTER_GAM_LINE_ITEM",
+ "FILTER_GAM_LINE_ITEM_ID",
+ "FILTER_DIGITAL_CONTENT_LABEL",
+ "FILTER_DOMAIN",
+ "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
+ "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
+ "FILTER_EXCHANGE",
+ "FILTER_EXCHANGE_CODE",
+ "FILTER_EXTENSION",
+ "FILTER_EXTENSION_STATUS",
+ "FILTER_EXTENSION_TYPE",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_FLOODLIGHT_ACTIVITY",
+ "FILTER_FORMAT",
+ "FILTER_GMAIL_AGE",
+ "FILTER_GMAIL_CITY",
+ "FILTER_GMAIL_COUNTRY",
+ "FILTER_GMAIL_COUNTRY_NAME",
+ "FILTER_GMAIL_DEVICE_TYPE",
+ "FILTER_GMAIL_DEVICE_TYPE_NAME",
+ "FILTER_GMAIL_GENDER",
+ "FILTER_GMAIL_REGION",
+ "FILTER_GMAIL_REMARKETING_LIST",
+ "FILTER_HOUSEHOLD_INCOME",
+ "FILTER_IMPRESSION_COUNTING_METHOD",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
+ "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
+ "FILTER_INSERTION_ORDER_STATUS",
+ "FILTER_INTEREST",
+ "FILTER_INVENTORY_SOURCE_GROUP",
+ "FILTER_INVENTORY_SOURCE_GROUP_ID",
+ "FILTER_INVENTORY_SOURCE_ID",
+ "FILTER_INVENTORY_SOURCE_NAME",
+ "FILTER_LIFE_EVENT",
+ "FILTER_LIFE_EVENTS",
+ "FILTER_LINE_ITEM_INTEGRATION_CODE",
+ "FILTER_LINE_ITEM_NAME",
+ "FILTER_LINE_ITEM_STATUS",
+ "FILTER_MATCH_RATIO",
+ "FILTER_MEASUREMENT_SOURCE",
+ "FILTER_MEDIA_PLAN_NAME",
+ "FILTER_PARENTAL_STATUS",
+ "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
+ "FILTER_PLATFORM",
+ "FILTER_PLAYBACK_METHOD",
+ "FILTER_POSITION_IN_CONTENT",
+ "FILTER_PUBLISHER_PROPERTY",
+ "FILTER_PUBLISHER_PROPERTY_ID",
+ "FILTER_PUBLISHER_PROPERTY_SECTION",
+ "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
+ "FILTER_REFUND_REASON",
+ "FILTER_REMARKETING_LIST",
+ "FILTER_REWARDED",
+ "FILTER_SENSITIVE_CATEGORY",
+ "FILTER_SERVED_PIXEL_DENSITY",
+ "FILTER_TARGETED_DATA_PROVIDERS",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_TRUEVIEW_AD",
+ "FILTER_TRUEVIEW_AD_GROUP",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
+ "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
+ "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
+ "FILTER_VARIANT_ID",
+ "FILTER_VARIANT_NAME",
+ "FILTER_VARIANT_VERSION",
+ "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
+ "FILTER_VERIFICATION_VIDEO_POSITION",
+ "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
+ "FILTER_VIDEO_CONTINUOUS_PLAY",
+ "FILTER_VIDEO_DURATION",
+ "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
+ "FILTER_YOUTUBE_AD_VIDEO",
+ "FILTER_YOUTUBE_AD_VIDEO_ID",
+ "FILTER_YOUTUBE_CHANNEL",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
+ "FILTER_YOUTUBE_VIDEO",
+ "FILTER_ZIP_POSTAL_CODE",
+ "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
+ "FILTER_TRUEVIEW_PLACEMENT_ID",
+ "FILTER_PATH_PATTERN_ID",
+ "FILTER_PATH_EVENT_INDEX",
+ "FILTER_EVENT_TYPE",
+ "FILTER_CHANNEL_GROUPING",
+ "FILTER_OM_SDK_AVAILABLE",
+ "FILTER_DATA_SOURCE",
+ "FILTER_CM360_PLACEMENT_ID",
+ "FILTER_TRUEVIEW_CLICK_TYPE_NAME",
+ "FILTER_TRUEVIEW_AD_TYPE_NAME",
+ "FILTER_VIDEO_CONTENT_DURATION",
+ "FILTER_MATCHED_GENRE_TARGET",
+ "FILTER_VIDEO_CONTENT_LIVE_STREAM",
+ "FILTER_BUDGET_SEGMENT_TYPE",
+ "FILTER_BUDGET_SEGMENT_BUDGET",
+ "FILTER_BUDGET_SEGMENT_START_DATE",
+ "FILTER_BUDGET_SEGMENT_END_DATE",
+ "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE",
+ "FILTER_LINE_ITEM_BUDGET",
+ "FILTER_LINE_ITEM_START_DATE",
+ "FILTER_LINE_ITEM_END_DATE",
+ "FILTER_INSERTION_ORDER_GOAL_TYPE",
+ "FILTER_LINE_ITEM_PACING_PERCENTAGE",
+ "FILTER_INSERTION_ORDER_GOAL_VALUE",
+ "FILTER_OMID_CAPABLE"
],
"enumDescriptions": [
- "v1 error format",
- "v2 error format"
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "location": "query",
"type": "string"
+ },
+ "type": "array"
},
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
+ "includeInviteData": {
+ "description": "Deprecated. This field is no longer in use.",
+ "type": "boolean"
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
+ "metrics": {
+ "description": "Metrics to include as columns in your report.",
+ "items": {
"enum": [
- "json",
- "media",
- "proto"
+ "METRIC_UNKNOWN",
+ "METRIC_IMPRESSIONS",
+ "METRIC_CLICKS",
+ "METRIC_LAST_IMPRESSIONS",
+ "METRIC_LAST_CLICKS",
+ "METRIC_TOTAL_CONVERSIONS",
+ "METRIC_MEDIA_COST_ADVERTISER",
+ "METRIC_MEDIA_COST_USD",
+ "METRIC_MEDIA_COST_PARTNER",
+ "METRIC_DATA_COST_ADVERTISER",
+ "METRIC_DATA_COST_USD",
+ "METRIC_DATA_COST_PARTNER",
+ "METRIC_CPM_FEE1_ADVERTISER",
+ "METRIC_CPM_FEE1_USD",
+ "METRIC_CPM_FEE1_PARTNER",
+ "METRIC_CPM_FEE2_ADVERTISER",
+ "METRIC_CPM_FEE2_USD",
+ "METRIC_CPM_FEE2_PARTNER",
+ "METRIC_MEDIA_FEE1_ADVERTISER",
+ "METRIC_MEDIA_FEE1_USD",
+ "METRIC_MEDIA_FEE1_PARTNER",
+ "METRIC_MEDIA_FEE2_ADVERTISER",
+ "METRIC_MEDIA_FEE2_USD",
+ "METRIC_MEDIA_FEE2_PARTNER",
+ "METRIC_REVENUE_ADVERTISER",
+ "METRIC_REVENUE_USD",
+ "METRIC_REVENUE_PARTNER",
+ "METRIC_PROFIT_ADVERTISER",
+ "METRIC_PROFIT_USD",
+ "METRIC_PROFIT_PARTNER",
+ "METRIC_PROFIT_MARGIN",
+ "METRIC_TOTAL_MEDIA_COST_USD",
+ "METRIC_TOTAL_MEDIA_COST_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ADVERTISER",
+ "METRIC_BILLABLE_COST_USD",
+ "METRIC_BILLABLE_COST_PARTNER",
+ "METRIC_BILLABLE_COST_ADVERTISER",
+ "METRIC_PLATFORM_FEE_USD",
+ "METRIC_PLATFORM_FEE_PARTNER",
+ "METRIC_PLATFORM_FEE_ADVERTISER",
+ "METRIC_VIDEO_COMPLETION_RATE",
+ "METRIC_PROFIT_ECPM_ADVERTISER",
+ "METRIC_PROFIT_ECPM_USD",
+ "METRIC_PROFIT_ECPM_PARTNER",
+ "METRIC_REVENUE_ECPM_ADVERTISER",
+ "METRIC_REVENUE_ECPM_USD",
+ "METRIC_REVENUE_ECPM_PARTNER",
+ "METRIC_REVENUE_ECPC_ADVERTISER",
+ "METRIC_REVENUE_ECPC_USD",
+ "METRIC_REVENUE_ECPC_PARTNER",
+ "METRIC_REVENUE_ECPA_ADVERTISER",
+ "METRIC_REVENUE_ECPA_USD",
+ "METRIC_REVENUE_ECPA_PARTNER",
+ "METRIC_REVENUE_ECPAPV_ADVERTISER",
+ "METRIC_REVENUE_ECPAPV_USD",
+ "METRIC_REVENUE_ECPAPV_PARTNER",
+ "METRIC_REVENUE_ECPAPC_ADVERTISER",
+ "METRIC_REVENUE_ECPAPC_USD",
+ "METRIC_REVENUE_ECPAPC_PARTNER",
+ "METRIC_MEDIA_COST_ECPM_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPM_USD",
+ "METRIC_MEDIA_COST_ECPM_PARTNER",
+ "METRIC_MEDIA_COST_ECPC_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPC_USD",
+ "METRIC_MEDIA_COST_ECPC_PARTNER",
+ "METRIC_MEDIA_COST_ECPA_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPA_USD",
+ "METRIC_MEDIA_COST_ECPA_PARTNER",
+ "METRIC_MEDIA_COST_ECPAPV_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPAPV_USD",
+ "METRIC_MEDIA_COST_ECPAPV_PARTNER",
+ "METRIC_MEDIA_COST_ECPAPC_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPAPC_USD",
+ "METRIC_MEDIA_COST_ECPAPC_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPM_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPC_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPA_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER",
+ "METRIC_RICH_MEDIA_VIDEO_PLAYS",
+ "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS",
+ "METRIC_RICH_MEDIA_VIDEO_PAUSES",
+ "METRIC_RICH_MEDIA_VIDEO_MUTES",
+ "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS",
+ "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS",
+ "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES",
+ "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES",
+ "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE",
+ "METRIC_IMPRESSIONS_TO_CONVERSION_RATE",
+ "METRIC_CONVERSIONS_PER_MILLE",
+ "METRIC_CTR",
+ "METRIC_BID_REQUESTS",
+ "METRIC_UNIQUE_VISITORS_COOKIES",
+ "METRIC_REVENUE_ECPCV_ADVERTISER",
+ "METRIC_REVENUE_ECPCV_USD",
+ "METRIC_REVENUE_ECPCV_PARTNER",
+ "METRIC_MEDIA_COST_ECPCV_ADVERTISER",
+ "METRIC_MEDIA_COST_ECPCV_USD",
+ "METRIC_MEDIA_COST_ECPCV_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_ECPCV_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_ECPCV_USD",
+ "METRIC_TOTAL_MEDIA_COST_ECPCV_PARTNER",
+ "METRIC_RICH_MEDIA_VIDEO_SKIPS",
+ "METRIC_FEE2_ADVERTISER",
+ "METRIC_FEE2_USD",
+ "METRIC_FEE2_PARTNER",
+ "METRIC_FEE3_ADVERTISER",
+ "METRIC_FEE3_USD",
+ "METRIC_FEE3_PARTNER",
+ "METRIC_FEE4_ADVERTISER",
+ "METRIC_FEE4_USD",
+ "METRIC_FEE4_PARTNER",
+ "METRIC_FEE5_ADVERTISER",
+ "METRIC_FEE5_USD",
+ "METRIC_FEE5_PARTNER",
+ "METRIC_FEE6_ADVERTISER",
+ "METRIC_FEE6_USD",
+ "METRIC_FEE6_PARTNER",
+ "METRIC_FEE7_ADVERTISER",
+ "METRIC_FEE7_USD",
+ "METRIC_FEE7_PARTNER",
+ "METRIC_FEE8_ADVERTISER",
+ "METRIC_FEE8_USD",
+ "METRIC_FEE8_PARTNER",
+ "METRIC_FEE9_ADVERTISER",
+ "METRIC_FEE9_USD",
+ "METRIC_FEE9_PARTNER",
+ "METRIC_FEE10_ADVERTISER",
+ "METRIC_FEE10_USD",
+ "METRIC_FEE10_PARTNER",
+ "METRIC_FEE11_ADVERTISER",
+ "METRIC_FEE11_USD",
+ "METRIC_FEE11_PARTNER",
+ "METRIC_FEE12_ADVERTISER",
+ "METRIC_FEE12_USD",
+ "METRIC_FEE12_PARTNER",
+ "METRIC_FEE13_ADVERTISER",
+ "METRIC_FEE13_USD",
+ "METRIC_FEE13_PARTNER",
+ "METRIC_FEE14_ADVERTISER",
+ "METRIC_FEE14_USD",
+ "METRIC_FEE14_PARTNER",
+ "METRIC_FEE15_ADVERTISER",
+ "METRIC_FEE15_USD",
+ "METRIC_FEE15_PARTNER",
+ "METRIC_CPM_FEE3_ADVERTISER",
+ "METRIC_CPM_FEE3_USD",
+ "METRIC_CPM_FEE3_PARTNER",
+ "METRIC_CPM_FEE4_ADVERTISER",
+ "METRIC_CPM_FEE4_USD",
+ "METRIC_CPM_FEE4_PARTNER",
+ "METRIC_CPM_FEE5_ADVERTISER",
+ "METRIC_CPM_FEE5_USD",
+ "METRIC_CPM_FEE5_PARTNER",
+ "METRIC_MEDIA_FEE3_ADVERTISER",
+ "METRIC_MEDIA_FEE3_USD",
+ "METRIC_MEDIA_FEE3_PARTNER",
+ "METRIC_MEDIA_FEE4_ADVERTISER",
+ "METRIC_MEDIA_FEE4_USD",
+ "METRIC_MEDIA_FEE4_PARTNER",
+ "METRIC_MEDIA_FEE5_ADVERTISER",
+ "METRIC_MEDIA_FEE5_USD",
+ "METRIC_MEDIA_FEE5_PARTNER",
+ "METRIC_VIDEO_COMPANION_IMPRESSIONS",
+ "METRIC_VIDEO_COMPANION_CLICKS",
+ "METRIC_FEE16_ADVERTISER",
+ "METRIC_FEE16_USD",
+ "METRIC_FEE16_PARTNER",
+ "METRIC_FEE17_ADVERTISER",
+ "METRIC_FEE17_USD",
+ "METRIC_FEE17_PARTNER",
+ "METRIC_FEE18_ADVERTISER",
+ "METRIC_FEE18_USD",
+ "METRIC_FEE18_PARTNER",
+ "METRIC_TRUEVIEW_VIEWS",
+ "METRIC_TRUEVIEW_UNIQUE_VIEWERS",
+ "METRIC_TRUEVIEW_EARNED_VIEWS",
+ "METRIC_TRUEVIEW_EARNED_SUBSCRIBERS",
+ "METRIC_TRUEVIEW_EARNED_PLAYLIST_ADDITIONS",
+ "METRIC_TRUEVIEW_EARNED_LIKES",
+ "METRIC_TRUEVIEW_EARNED_SHARES",
+ "METRIC_TRUEVIEW_IMPRESSION_SHARE",
+ "METRIC_TRUEVIEW_LOST_IS_BUDGET",
+ "METRIC_TRUEVIEW_LOST_IS_RANK",
+ "METRIC_TRUEVIEW_VIEW_THROUGH_CONVERSION",
+ "METRIC_TRUEVIEW_CONVERSION_MANY_PER_VIEW",
+ "METRIC_TRUEVIEW_VIEW_RATE",
+ "METRIC_TRUEVIEW_CONVERSION_RATE_ONE_PER_VIEW",
+ "METRIC_TRUEVIEW_CPV_ADVERTISER",
+ "METRIC_TRUEVIEW_CPV_USD",
+ "METRIC_TRUEVIEW_CPV_PARTNER",
+ "METRIC_FEE19_ADVERTISER",
+ "METRIC_FEE19_USD",
+ "METRIC_FEE19_PARTNER",
+ "METRIC_TEA_TRUEVIEW_IMPRESSIONS",
+ "METRIC_TEA_TRUEVIEW_UNIQUE_COOKIES",
+ "METRIC_FEE20_ADVERTISER",
+ "METRIC_FEE20_USD",
+ "METRIC_FEE20_PARTNER",
+ "METRIC_FEE21_ADVERTISER",
+ "METRIC_FEE21_USD",
+ "METRIC_FEE21_PARTNER",
+ "METRIC_FEE22_ADVERTISER",
+ "METRIC_FEE22_USD",
+ "METRIC_FEE22_PARTNER",
+ "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_ADVERTISER",
+ "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_USD",
+ "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_PARTNER",
+ "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_ADVERTISER",
+ "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_USD",
+ "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_PARTNER",
+ "METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER",
+ "METRIC_PROFIT_VIEWABLE_ECPM_USD",
+ "METRIC_PROFIT_VIEWABLE_ECPM_PARTNER",
+ "METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER",
+ "METRIC_REVENUE_VIEWABLE_ECPM_USD",
+ "METRIC_REVENUE_VIEWABLE_ECPM_PARTNER",
+ "METRIC_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
+ "METRIC_MEDIA_COST_VIEWABLE_ECPM_USD",
+ "METRIC_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
+ "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
+ "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_USD",
+ "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
+ "METRIC_TRUEVIEW_ENGAGEMENTS",
+ "METRIC_TRUEVIEW_ENGAGEMENT_RATE",
+ "METRIC_TRUEVIEW_AVERAGE_CPE_ADVERTISER",
+ "METRIC_TRUEVIEW_AVERAGE_CPE_USD",
+ "METRIC_TRUEVIEW_AVERAGE_CPE_PARTNER",
+ "METRIC_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_PCT_MEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_PCT_VIEWABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME",
+ "METRIC_ACTIVE_VIEW_UNMEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_UNVIEWABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNMEASURABLE",
+ "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNVIEWABLE",
+ "METRIC_ACTIVE_VIEW_DISTRIBUTION_VIEWABLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_VIEWABLE_FOR_TIME_THRESHOLD",
+ "METRIC_ACTIVE_VIEW_VIEWABLE_FOR_TIME_THRESHOLD",
+ "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_AT_START",
+ "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_FIRST_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_SECOND_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_THIRD_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_ON_COMPLETE",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_AT_START",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_FIRST_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_SECOND_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_THIRD_QUAR",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_ON_COMPLETE",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_VISIBLE_ON_COMPLETE_IMPRESSIONS",
+ "METRIC_VIEWABLE_BID_REQUESTS",
+ "METRIC_COOKIE_REACH_IMPRESSION_REACH",
+ "METRIC_COOKIE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
+ "METRIC_DBM_ENGAGEMENT_RATE",
+ "METRIC_RICH_MEDIA_SCROLLS",
+ "METRIC_CM_POST_VIEW_REVENUE",
+ "METRIC_CM_POST_CLICK_REVENUE",
+ "METRIC_FLOODLIGHT_IMPRESSIONS",
+ "METRIC_BILLABLE_IMPRESSIONS",
+ "METRIC_NIELSEN_AVERAGE_FREQUENCY",
+ "METRIC_NIELSEN_IMPRESSIONS",
+ "METRIC_NIELSEN_UNIQUE_AUDIENCE",
+ "METRIC_NIELSEN_GRP",
+ "METRIC_NIELSEN_IMPRESSION_INDEX",
+ "METRIC_NIELSEN_IMPRESSIONS_SHARE",
+ "METRIC_NIELSEN_POPULATION",
+ "METRIC_NIELSEN_POPULATION_REACH",
+ "METRIC_NIELSEN_POPULATION_SHARE",
+ "METRIC_NIELSEN_REACH_INDEX",
+ "METRIC_NIELSEN_REACH_SHARE",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_MEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_RATE",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_MEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_RATE",
+ "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_MEASURABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_VIEWABLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_VIEWABLE_RATE",
+ "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_IMPRESSIONS",
+ "METRIC_ACTIVE_VIEW_PERCENT_FULLY_ON_SCREEN_2_SEC",
+ "METRIC_ACTIVE_VIEW_PERCENT_FULL_SCREEN",
+ "METRIC_ACTIVE_VIEW_PERCENT_IN_BACKGROUND",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_AD_PLAYED",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_COMPLETED_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_COMPLETED_IMPRESSIONS_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_FIRST_QUARTILE_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_FIRST_QUARTILE_IMPRESSIONS_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_MIDPOINT_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_MIDPOINT_IMPRESSIONS_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_THIRD_QUARTILE_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_OF_THIRD_QUARTILE_IMPRESSIONS_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_AUDIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_AUDIBLE_AND_VISIBLE",
+ "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_VISIBLE",
+ "METRIC_ADAPTED_AUDIENCE_FREQUENCY",
+ "METRIC_ADLINGO_FEE_ADVERTISER_CURRENCY",
+ "METRIC_AUDIO_CLIENT_COST_ECPCL_ADVERTISER_CURRENCY",
+ "METRIC_AUDIO_MEDIA_COST_ECPCL_ADVERTISER_CURRENCY",
+ "METRIC_AUDIO_MUTES_AUDIO",
+ "METRIC_AUDIO_REVENUE_ECPCL_ADVERTISER_CURRENCY",
+ "METRIC_AUDIO_UNMUTES_AUDIO",
+ "METRIC_AUDIO_UNMUTES_VIDEO",
+ "METRIC_AVERAGE_DISPLAY_TIME",
+ "METRIC_AVERAGE_IMPRESSION_FREQUENCY_PER_USER",
+ "METRIC_AVERAGE_INTERACTION_TIME",
+ "METRIC_AVERAGE_WATCH_TIME_PER_IMPRESSION",
+ "METRIC_BEGIN_TO_RENDER_ELIGIBLE_IMPRESSIONS",
+ "METRIC_BEGIN_TO_RENDER_IMPRESSIONS",
+ "METRIC_BENCHMARK_FREQUENCY",
+ "METRIC_BRAND_LIFT_ABSOLUTE_BRAND_LIFT",
+ "METRIC_BRAND_LIFT_ALL_SURVEY_RESPONSES",
+ "METRIC_BRAND_LIFT_BASELINE_POSITIVE_RESPONSE_RATE",
+ "METRIC_BRAND_LIFT_BASELINE_SURVEY_RESPONSES",
+ "METRIC_BRAND_LIFT_COST_PER_LIFTED_USER",
+ "METRIC_BRAND_LIFT_EXPOSED_SURVEY_RESPONSES",
+ "METRIC_BRAND_LIFT_HEADROOM_BRAND_LIFT",
+ "METRIC_BRAND_LIFT_RELATIVE_BRAND_LIFT",
+ "METRIC_BRAND_LIFT_USERS",
+ "METRIC_CARD_CLICKS",
+ "METRIC_CLIENT_COST_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_ECPA_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_ECPA_PC_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_ECPA_PV_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_ECPC_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_ECPM_ADVERTISER_CURRENCY",
+ "METRIC_CLIENT_COST_VIEWABLE_ECPM_ADVERTISER_CURRENCY",
+ "METRIC_CM_POST_CLICK_REVENUE_CROSS_ENVIRONMENT",
+ "METRIC_CM_POST_VIEW_REVENUE_CROSS_ENVIRONMENT",
+ "METRIC_COMPANION_CLICKS_AUDIO",
+ "METRIC_COMPANION_IMPRESSIONS_AUDIO",
+ "METRIC_COMPLETE_LISTENS_AUDIO",
+ "METRIC_COMPLETION_RATE_AUDIO",
+ "METRIC_COUNTERS",
+ "METRIC_CUSTOM_FEE_1_ADVERTISER_CURRENCY",
+ "METRIC_CUSTOM_FEE_2_ADVERTISER_CURRENCY",
+ "METRIC_CUSTOM_FEE_3_ADVERTISER_CURRENCY",
+ "METRIC_CUSTOM_FEE_4_ADVERTISER_CURRENCY",
+ "METRIC_CUSTOM_FEE_5_ADVERTISER_CURRENCY",
+ "METRIC_CUSTOM_VALUE_PER_1000_IMPRESSIONS",
+ "METRIC_ENGAGEMENTS",
+ "METRIC_ESTIMATED_CPM_FOR_IMPRESSIONS_WITH_CUSTOM_VALUE_ADVERTISER_CURRENCY",
+ "METRIC_ESTIMATED_TOTAL_COST_FOR_IMPRESSIONS_WITH_CUSTOM_VALUE_ADVERTISER_CURRENCY",
+ "METRIC_EXITS",
+ "METRIC_EXPANSIONS",
+ "METRIC_FIRST_QUARTILE_AUDIO",
+ "METRIC_GENERAL_INVALID_TRAFFIC_GIVT_IMPRESSIONS",
+ "METRIC_GENERAL_INVALID_TRAFFIC_GIVT_TRACKED_ADS",
+ "METRIC_GIVT_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
+ "METRIC_GIVT_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
+ "METRIC_GIVT_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
+ "METRIC_GIVT_BEGIN_TO_RENDER_IMPRESSIONS",
+ "METRIC_GIVT_CLICKS",
+ "METRIC_GMAIL_CONVERSIONS",
+ "METRIC_GMAIL_POST_CLICK_CONVERSIONS",
+ "METRIC_GMAIL_POST_VIEW_CONVERSIONS",
+ "METRIC_GMAIL_POTENTIAL_VIEWS",
+ "METRIC_IMPRESSIONS_WITH_CUSTOM_VALUE",
+ "METRIC_IMPRESSIONS_WITH_POSITIVE_CUSTOM_VALUE",
+ "METRIC_IMPRESSION_CUSTOM_VALUE_COST",
+ "METRIC_INTERACTIVE_IMPRESSIONS",
+ "METRIC_INVALID_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
+ "METRIC_INVALID_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
+ "METRIC_INVALID_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
+ "METRIC_INVALID_BEGIN_TO_RENDER_IMPRESSIONS",
+ "METRIC_INVALID_CLICKS",
+ "METRIC_INVALID_IMPRESSIONS",
+ "METRIC_INVALID_TRACKED_ADS",
+ "METRIC_MEDIA_COST_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
+ "METRIC_MIDPOINT_AUDIO",
+ "METRIC_ORIGINAL_AUDIENCE_FREQUENCY",
+ "METRIC_PAUSES_AUDIO",
+ "METRIC_PERCENT_IMPRESSIONS_WITH_POSITIVE_CUSTOM_VALUE",
+ "METRIC_PLATFORM_FEE_RATE",
+ "METRIC_POST_CLICK_CONVERSIONS_CROSS_ENVIRONMENT",
+ "METRIC_POST_VIEW_CONVERSIONS_CROSS_ENVIRONMENT",
+ "METRIC_POTENTIAL_IMPRESSIONS",
+ "METRIC_POTENTIAL_VIEWS",
+ "METRIC_PREMIUM_FEE_ADVERTISER_CURRENCY",
+ "METRIC_PROGRAMMATIC_GUARANTEED_IMPRESSIONS_PASSED_DUE_TO_FREQUENCY",
+ "METRIC_PROGRAMMATIC_GUARANTEED_SAVINGS_RE_INVESTED_DUE_TO_FREQUENCY_ADVERTISER_CURRENCY",
+ "METRIC_REFUND_BILLABLE_COST_ADVERTISER_CURRENCY",
+ "METRIC_REFUND_MEDIA_COST_ADVERTISER_CURRENCY",
+ "METRIC_REFUND_PLATFORM_FEE_ADVERTISER_CURRENCY",
+ "METRIC_REVENUE_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
+ "METRIC_RICH_MEDIA_ENGAGEMENTS",
+ "METRIC_STARTS_AUDIO",
+ "METRIC_STOPS_AUDIO",
+ "METRIC_STORE_VISITS_ADX_ONLY",
+ "METRIC_STORE_VISIT_CONVERSIONS",
+ "METRIC_THIRD_QUARTILE_AUDIO",
+ "METRIC_TIMERS",
+ "METRIC_TOTAL_AUDIO_MEDIA_COST_ECPCL_ADVERTISER_CURRENCY",
+ "METRIC_TOTAL_CONVERSIONS_CROSS_ENVIRONMENT",
+ "METRIC_TOTAL_DISPLAY_TIME",
+ "METRIC_TOTAL_IMPRESSION_CUSTOM_VALUE",
+ "METRIC_TOTAL_INTERACTION_TIME",
+ "METRIC_TOTAL_MEDIA_COST_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
+ "METRIC_TOTAL_USERS",
+ "METRIC_TRACKED_ADS",
+ "METRIC_TRUEVIEW_GENERAL_INVALID_TRAFFIC_GIVT_VIEWS",
+ "METRIC_TRUEVIEW_INVALID_VIEWS",
+ "METRIC_UNIQUE_COOKIES_WITH_IMPRESSIONS",
+ "METRIC_UNIQUE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
+ "METRIC_UNIQUE_REACH_CLICK_REACH",
+ "METRIC_UNIQUE_REACH_IMPRESSION_REACH",
+ "METRIC_UNIQUE_REACH_TOTAL_REACH",
+ "METRIC_VERIFIABLE_IMPRESSIONS",
+ "METRIC_VIDEO_CLIENT_COST_ECPCV_ADVERTISER_CURRENCY",
+ "METRIC_WATCH_TIME",
+ "METRIC_LAST_TOUCH_TOTAL_CONVERSIONS",
+ "METRIC_LAST_TOUCH_CLICK_THROUGH_CONVERSIONS",
+ "METRIC_LAST_TOUCH_VIEW_THROUGH_CONVERSIONS",
+ "METRIC_TOTAL_PATHS",
+ "METRIC_TOTAL_EXPOSURES",
+ "METRIC_PATH_CONVERSION_RATE",
+ "METRIC_CONVERTING_PATHS",
+ "METRIC_ACTIVITY_REVENUE",
+ "METRIC_PERCENT_INVALID_IMPRESSIONS_PREBID",
+ "METRIC_GRP_CORRECTED_IMPRESSIONS",
+ "METRIC_DEMO_CORRECTED_CLICKS",
+ "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_BY_DEMO",
+ "METRIC_VIRTUAL_PEOPLE_CLICK_REACH_BY_DEMO",
+ "METRIC_VIRTUAL_PEOPLE_AVERAGE_IMPRESSION_FREQUENCY_BY_DEMO",
+ "METRIC_DEMO_COMPOSITION_IMPRESSION",
+ "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_SHARE_PERCENT",
+ "METRIC_DEMO_POPULATION",
+ "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_PERCENT",
+ "METRIC_TARGET_RATING_POINTS",
+ "METRIC_PROVISIONAL_IMPRESSIONS",
+ "METRIC_VENDOR_BLOCKED_ADS",
+ "METRIC_GRP_CORRECTED_VIEWABLE_IMPRESSIONS",
+ "METRIC_GRP_CORRECTED_VIEWABLE_IMPRESSIONS_SHARE_PERCENT",
+ "METRIC_VIEWABLE_GROSS_RATING_POINTS",
+ "METRIC_VIRTUAL_PEOPLE_AVERAGE_VIEWABLE_IMPRESSION_FREQUENCY_BY_DEMO",
+ "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_BY_DEMO",
+ "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_PERCENT",
+ "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_SHARE_PERCENT",
+ "METRIC_ENGAGEMENT_RATE",
+ "METRIC_CM360_POST_VIEW_REVENUE",
+ "METRIC_CM360_POST_CLICK_REVENUE",
+ "METRIC_CM360_POST_CLICK_REVENUE_CROSS_ENVIRONMENT",
+ "METRIC_CM360_POST_VIEW_REVENUE_CROSS_ENVIRONMENT",
+ "METRIC_PERCENTAGE_FROM_CURRENT_IO_GOAL",
+ "METRIC_OMID_CAPABLE",
+ "METRIC_DUPLICATE_FLOODLIGHT_IMPRESSIONS",
+ "METRIC_COOKIE_CONSENTED_FLOODLIGHT_IMPRESSIONS",
+ "METRIC_COOKIE_UNCONSENTED_FLOODLIGHT_IMPRESSIONS"
],
"enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
"type": "string"
+ },
+ "type": "array"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
+ "options": {
+ "$ref": "Options",
+ "description": "Additional query options."
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
+ "type": {
+ "description": "Report type.",
+ "enum": [
+ "TYPE_GENERAL",
+ "TYPE_AUDIENCE_PERFORMANCE",
+ "TYPE_INVENTORY_AVAILABILITY",
+ "TYPE_KEYWORD",
+ "TYPE_PIXEL_LOAD",
+ "TYPE_AUDIENCE_COMPOSITION",
+ "TYPE_CROSS_PARTNER",
+ "TYPE_PAGE_CATEGORY",
+ "TYPE_THIRD_PARTY_DATA_PROVIDER",
+ "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER",
+ "TYPE_CLIENT_SAFE",
+ "TYPE_ORDER_ID",
+ "TYPE_FEE",
+ "TYPE_CROSS_FEE",
+ "TYPE_ACTIVE_GRP",
+ "TYPE_YOUTUBE_VERTICAL",
+ "TYPE_COMSCORE_VCE",
+ "TYPE_TRUEVIEW",
+ "TYPE_NIELSEN_AUDIENCE_PROFILE",
+ "TYPE_NIELSEN_DAILY_REACH_BUILD",
+ "TYPE_NIELSEN_SITE",
+ "TYPE_REACH_AND_FREQUENCY",
+ "TYPE_ESTIMATED_CONVERSION",
+ "TYPE_VERIFICATION",
+ "TYPE_TRUEVIEW_IAR",
+ "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET",
+ "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE",
+ "TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD",
+ "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET",
+ "TYPE_NOT_SUPPORTED",
+ "TYPE_REACH_AUDIENCE",
+ "TYPE_LINEAR_TV_SEARCH_LIFT",
+ "TYPE_PATH",
+ "TYPE_PATH_ATTRIBUTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PathFilter": {
+ "description": "Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.",
+ "id": "PathFilter",
+ "properties": {
+ "eventFilters": {
+ "description": "Filter on an event to be applied to some part of the path.",
+ "items": {
+ "$ref": "EventFilter"
+ },
+ "type": "array"
},
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
+ "pathMatchPosition": {
+ "description": "Indicates the position of the path the filter should match to (first, last, or any event in path).",
+ "enum": [
+ "ANY",
+ "FIRST",
+ "LAST"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PathQueryOptions": {
+ "description": "Path Query Options for Report Options.",
+ "id": "PathQueryOptions",
+ "properties": {
+ "channelGrouping": {
+ "$ref": "ChannelGrouping",
+ "description": "Custom Channel Groupings."
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
+ "pathFilters": {
+ "description": "Path Filters. There is a limit of 100 path filters that can be set per report.",
+ "items": {
+ "$ref": "PathFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PathQueryOptionsFilter": {
+ "description": "Dimension Filter on path events.",
+ "id": "PathQueryOptionsFilter",
+ "properties": {
+ "filter": {
+ "description": "Dimension the filter is applied to.",
+ "enum": [
+ "FILTER_UNKNOWN",
+ "FILTER_DATE",
+ "FILTER_DAY_OF_WEEK",
+ "FILTER_WEEK",
+ "FILTER_MONTH",
+ "FILTER_YEAR",
+ "FILTER_TIME_OF_DAY",
+ "FILTER_CONVERSION_DELAY",
+ "FILTER_CREATIVE_ID",
+ "FILTER_CREATIVE_SIZE",
+ "FILTER_CREATIVE_TYPE",
+ "FILTER_EXCHANGE_ID",
+ "FILTER_AD_POSITION",
+ "FILTER_PUBLIC_INVENTORY",
+ "FILTER_INVENTORY_SOURCE",
+ "FILTER_CITY",
+ "FILTER_REGION",
+ "FILTER_DMA",
+ "FILTER_COUNTRY",
+ "FILTER_SITE_ID",
+ "FILTER_CHANNEL_ID",
+ "FILTER_PARTNER",
+ "FILTER_ADVERTISER",
+ "FILTER_INSERTION_ORDER",
+ "FILTER_LINE_ITEM",
+ "FILTER_PARTNER_CURRENCY",
+ "FILTER_ADVERTISER_CURRENCY",
+ "FILTER_ADVERTISER_TIMEZONE",
+ "FILTER_LINE_ITEM_TYPE",
+ "FILTER_USER_LIST",
+ "FILTER_USER_LIST_FIRST_PARTY",
+ "FILTER_USER_LIST_THIRD_PARTY",
+ "FILTER_TARGETED_USER_LIST",
+ "FILTER_DATA_PROVIDER",
+ "FILTER_ORDER_ID",
+ "FILTER_VIDEO_PLAYER_SIZE",
+ "FILTER_VIDEO_DURATION_SECONDS",
+ "FILTER_KEYWORD",
+ "FILTER_PAGE_CATEGORY",
+ "FILTER_CAMPAIGN_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
+ "FILTER_OS",
+ "FILTER_BROWSER",
+ "FILTER_CARRIER",
+ "FILTER_SITE_LANGUAGE",
+ "FILTER_INVENTORY_FORMAT",
+ "FILTER_ZIP_CODE",
+ "FILTER_VIDEO_RATING_TIER",
+ "FILTER_VIDEO_FORMAT_SUPPORT",
+ "FILTER_VIDEO_SKIPPABLE_SUPPORT",
+ "FILTER_VIDEO_CREATIVE_DURATION",
+ "FILTER_PAGE_LAYOUT",
+ "FILTER_VIDEO_AD_POSITION_IN_STREAM",
+ "FILTER_AGE",
+ "FILTER_GENDER",
+ "FILTER_QUARTER",
+ "FILTER_TRUEVIEW_CONVERSION_TYPE",
+ "FILTER_MOBILE_GEO",
+ "FILTER_MRAID_SUPPORT",
+ "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
+ "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
+ "FILTER_NIELSEN_COUNTRY_CODE",
+ "FILTER_NIELSEN_DEVICE_ID",
+ "FILTER_NIELSEN_GENDER",
+ "FILTER_NIELSEN_AGE",
+ "FILTER_INVENTORY_SOURCE_TYPE",
+ "FILTER_CREATIVE_WIDTH",
+ "FILTER_CREATIVE_HEIGHT",
+ "FILTER_DFP_ORDER_ID",
+ "FILTER_TRUEVIEW_AGE",
+ "FILTER_TRUEVIEW_GENDER",
+ "FILTER_TRUEVIEW_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_INTEREST",
+ "FILTER_TRUEVIEW_AD_GROUP_ID",
+ "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
+ "FILTER_TRUEVIEW_IAR_LANGUAGE",
+ "FILTER_TRUEVIEW_IAR_GENDER",
+ "FILTER_TRUEVIEW_IAR_AGE",
+ "FILTER_TRUEVIEW_IAR_CATEGORY",
+ "FILTER_TRUEVIEW_IAR_COUNTRY",
+ "FILTER_TRUEVIEW_IAR_CITY",
+ "FILTER_TRUEVIEW_IAR_REGION",
+ "FILTER_TRUEVIEW_IAR_ZIPCODE",
+ "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_IAR_INTEREST",
+ "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
+ "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
+ "FILTER_TRUEVIEW_CATEGORY",
+ "FILTER_TRUEVIEW_KEYWORD",
+ "FILTER_TRUEVIEW_PLACEMENT",
+ "FILTER_TRUEVIEW_URL",
+ "FILTER_TRUEVIEW_COUNTRY",
+ "FILTER_TRUEVIEW_REGION",
+ "FILTER_TRUEVIEW_CITY",
+ "FILTER_TRUEVIEW_DMA",
+ "FILTER_TRUEVIEW_ZIPCODE",
+ "FILTER_NOT_SUPPORTED",
+ "FILTER_MEDIA_PLAN",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
+ "FILTER_SKIPPABLE_SUPPORT",
+ "FILTER_COMPANION_CREATIVE_ID",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
+ "FILTER_FLOODLIGHT_ACTIVITY_ID",
+ "FILTER_DEVICE_MODEL",
+ "FILTER_DEVICE_MAKE",
+ "FILTER_DEVICE_TYPE",
+ "FILTER_CREATIVE_ATTRIBUTE",
+ "FILTER_INVENTORY_COMMITMENT_TYPE",
+ "FILTER_INVENTORY_RATE_TYPE",
+ "FILTER_INVENTORY_DELIVERY_METHOD",
+ "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
+ "FILTER_AUTHORIZED_SELLER_STATE",
+ "FILTER_VIDEO_DURATION_SECONDS_RANGE",
+ "FILTER_PARTNER_NAME",
+ "FILTER_PARTNER_STATUS",
+ "FILTER_ADVERTISER_NAME",
+ "FILTER_ADVERTISER_INTEGRATION_CODE",
+ "FILTER_ADVERTISER_INTEGRATION_STATUS",
+ "FILTER_CARRIER_NAME",
+ "FILTER_CHANNEL_NAME",
+ "FILTER_CITY_NAME",
+ "FILTER_COMPANION_CREATIVE_NAME",
+ "FILTER_USER_LIST_FIRST_PARTY_NAME",
+ "FILTER_USER_LIST_THIRD_PARTY_NAME",
+ "FILTER_NIELSEN_RESTATEMENT_DATE",
+ "FILTER_NIELSEN_DATE_RANGE",
+ "FILTER_INSERTION_ORDER_NAME",
+ "FILTER_REGION_NAME",
+ "FILTER_DMA_NAME",
+ "FILTER_TRUEVIEW_IAR_REGION_NAME",
+ "FILTER_TRUEVIEW_DMA_NAME",
+ "FILTER_TRUEVIEW_REGION_NAME",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
+ "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
+ "FILTER_AD_TYPE",
+ "FILTER_ALGORITHM",
+ "FILTER_ALGORITHM_ID",
+ "FILTER_AMP_PAGE_REQUEST",
+ "FILTER_ANONYMOUS_INVENTORY_MODELING",
+ "FILTER_APP_URL",
+ "FILTER_APP_URL_EXCLUDED",
+ "FILTER_ATTRIBUTED_USERLIST",
+ "FILTER_ATTRIBUTED_USERLIST_COST",
+ "FILTER_ATTRIBUTED_USERLIST_TYPE",
+ "FILTER_ATTRIBUTION_MODEL",
+ "FILTER_AUDIENCE_LIST",
+ "FILTER_AUDIENCE_LIST_COST",
+ "FILTER_AUDIENCE_LIST_TYPE",
+ "FILTER_AUDIENCE_NAME",
+ "FILTER_AUDIENCE_TYPE",
+ "FILTER_BILLABLE_OUTCOME",
+ "FILTER_BRAND_LIFT_TYPE",
+ "FILTER_CHANNEL_TYPE",
+ "FILTER_CM_PLACEMENT_ID",
+ "FILTER_CONVERSION_SOURCE",
+ "FILTER_CONVERSION_SOURCE_ID",
+ "FILTER_COUNTRY_ID",
+ "FILTER_CREATIVE",
+ "FILTER_CREATIVE_ASSET",
+ "FILTER_CREATIVE_INTEGRATION_CODE",
+ "FILTER_CREATIVE_RENDERED_IN_AMP",
+ "FILTER_CREATIVE_SOURCE",
+ "FILTER_CREATIVE_STATUS",
+ "FILTER_DATA_PROVIDER_NAME",
+ "FILTER_DETAILED_DEMOGRAPHICS",
+ "FILTER_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_DEVICE",
+ "FILTER_GAM_INSERTION_ORDER",
+ "FILTER_GAM_LINE_ITEM",
+ "FILTER_GAM_LINE_ITEM_ID",
+ "FILTER_DIGITAL_CONTENT_LABEL",
+ "FILTER_DOMAIN",
+ "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
+ "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
+ "FILTER_EXCHANGE",
+ "FILTER_EXCHANGE_CODE",
+ "FILTER_EXTENSION",
+ "FILTER_EXTENSION_STATUS",
+ "FILTER_EXTENSION_TYPE",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_FLOODLIGHT_ACTIVITY",
+ "FILTER_FORMAT",
+ "FILTER_GMAIL_AGE",
+ "FILTER_GMAIL_CITY",
+ "FILTER_GMAIL_COUNTRY",
+ "FILTER_GMAIL_COUNTRY_NAME",
+ "FILTER_GMAIL_DEVICE_TYPE",
+ "FILTER_GMAIL_DEVICE_TYPE_NAME",
+ "FILTER_GMAIL_GENDER",
+ "FILTER_GMAIL_REGION",
+ "FILTER_GMAIL_REMARKETING_LIST",
+ "FILTER_HOUSEHOLD_INCOME",
+ "FILTER_IMPRESSION_COUNTING_METHOD",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
+ "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
+ "FILTER_INSERTION_ORDER_STATUS",
+ "FILTER_INTEREST",
+ "FILTER_INVENTORY_SOURCE_GROUP",
+ "FILTER_INVENTORY_SOURCE_GROUP_ID",
+ "FILTER_INVENTORY_SOURCE_ID",
+ "FILTER_INVENTORY_SOURCE_NAME",
+ "FILTER_LIFE_EVENT",
+ "FILTER_LIFE_EVENTS",
+ "FILTER_LINE_ITEM_INTEGRATION_CODE",
+ "FILTER_LINE_ITEM_NAME",
+ "FILTER_LINE_ITEM_STATUS",
+ "FILTER_MATCH_RATIO",
+ "FILTER_MEASUREMENT_SOURCE",
+ "FILTER_MEDIA_PLAN_NAME",
+ "FILTER_PARENTAL_STATUS",
+ "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
+ "FILTER_PLATFORM",
+ "FILTER_PLAYBACK_METHOD",
+ "FILTER_POSITION_IN_CONTENT",
+ "FILTER_PUBLISHER_PROPERTY",
+ "FILTER_PUBLISHER_PROPERTY_ID",
+ "FILTER_PUBLISHER_PROPERTY_SECTION",
+ "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
+ "FILTER_REFUND_REASON",
+ "FILTER_REMARKETING_LIST",
+ "FILTER_REWARDED",
+ "FILTER_SENSITIVE_CATEGORY",
+ "FILTER_SERVED_PIXEL_DENSITY",
+ "FILTER_TARGETED_DATA_PROVIDERS",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
+ "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
+ "FILTER_TRUEVIEW_AD",
+ "FILTER_TRUEVIEW_AD_GROUP",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
+ "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
+ "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
+ "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
+ "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
+ "FILTER_VARIANT_ID",
+ "FILTER_VARIANT_NAME",
+ "FILTER_VARIANT_VERSION",
+ "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
+ "FILTER_VERIFICATION_VIDEO_POSITION",
+ "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
+ "FILTER_VIDEO_CONTINUOUS_PLAY",
+ "FILTER_VIDEO_DURATION",
+ "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
+ "FILTER_YOUTUBE_AD_VIDEO",
+ "FILTER_YOUTUBE_AD_VIDEO_ID",
+ "FILTER_YOUTUBE_CHANNEL",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
+ "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
+ "FILTER_YOUTUBE_VIDEO",
+ "FILTER_ZIP_POSTAL_CODE",
+ "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
+ "FILTER_TRUEVIEW_PLACEMENT_ID",
+ "FILTER_PATH_PATTERN_ID",
+ "FILTER_PATH_EVENT_INDEX",
+ "FILTER_EVENT_TYPE",
+ "FILTER_CHANNEL_GROUPING",
+ "FILTER_OM_SDK_AVAILABLE",
+ "FILTER_DATA_SOURCE",
+ "FILTER_CM360_PLACEMENT_ID",
+ "FILTER_TRUEVIEW_CLICK_TYPE_NAME",
+ "FILTER_TRUEVIEW_AD_TYPE_NAME",
+ "FILTER_VIDEO_CONTENT_DURATION",
+ "FILTER_MATCHED_GENRE_TARGET",
+ "FILTER_VIDEO_CONTENT_LIVE_STREAM",
+ "FILTER_BUDGET_SEGMENT_TYPE",
+ "FILTER_BUDGET_SEGMENT_BUDGET",
+ "FILTER_BUDGET_SEGMENT_START_DATE",
+ "FILTER_BUDGET_SEGMENT_END_DATE",
+ "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE",
+ "FILTER_LINE_ITEM_BUDGET",
+ "FILTER_LINE_ITEM_START_DATE",
+ "FILTER_LINE_ITEM_END_DATE",
+ "FILTER_INSERTION_ORDER_GOAL_TYPE",
+ "FILTER_LINE_ITEM_PACING_PERCENTAGE",
+ "FILTER_INSERTION_ORDER_GOAL_VALUE",
+ "FILTER_OMID_CAPABLE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
+ "match": {
+ "description": "Indicates how the filter should be matched to the value.",
+ "enum": [
+ "UNKNOWN",
+ "EXACT",
+ "PARTIAL",
+ "BEGINS_WITH",
+ "WILDCARD_EXPRESSION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
+ "values": {
+ "description": "Value to filter on.",
+ "items": {
"type": "string"
+ },
+ "type": "array"
}
+ },
+ "type": "object"
},
- "protocol": "rest",
- "resources": {
- "lineitems": {
- "methods": {
- "downloadlineitems": {
- "description": "Retrieves line items in CSV format. YouTube & partners line items are not supported.",
- "flatPath": "lineitems/downloadlineitems",
- "httpMethod": "POST",
- "id": "doubleclickbidmanager.lineitems.downloadlineitems",
- "parameterOrder": [],
- "parameters": {},
- "path": "lineitems/downloadlineitems",
- "request": {
- "$ref": "DownloadLineItemsRequest"
- },
- "response": {
- "$ref": "DownloadLineItemsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- },
- "uploadlineitems": {
- "description": "Uploads line items in CSV format. YouTube & partners line items are not supported.",
- "flatPath": "lineitems/uploadlineitems",
- "httpMethod": "POST",
- "id": "doubleclickbidmanager.lineitems.uploadlineitems",
- "parameterOrder": [],
- "parameters": {},
- "path": "lineitems/uploadlineitems",
- "request": {
- "$ref": "UploadLineItemsRequest"
- },
- "response": {
- "$ref": "UploadLineItemsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- }
- }
+ "Query": {
+ "description": "Represents a query.",
+ "id": "Query",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\".",
+ "type": "string"
},
- "queries": {
- "methods": {
- "createquery": {
- "description": "Creates a query.",
- "flatPath": "query",
- "httpMethod": "POST",
- "id": "doubleclickbidmanager.queries.createquery",
- "parameterOrder": [],
- "parameters": {
- "asynchronous": {
- "default": "false",
- "description": "If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "query",
- "request": {
- "$ref": "Query"
- },
- "response": {
- "$ref": "Query"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- },
- "deletequery": {
- "description": "Deletes a stored query as well as the associated stored reports.",
- "flatPath": "query/{queryId}",
- "httpMethod": "DELETE",
- "id": "doubleclickbidmanager.queries.deletequery",
- "parameterOrder": [
- "queryId"
- ],
- "parameters": {
- "queryId": {
- "description": "Query ID to delete.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "query/{queryId}",
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- },
- "getquery": {
- "description": "Retrieves a stored query.",
- "flatPath": "query/{queryId}",
- "httpMethod": "GET",
- "id": "doubleclickbidmanager.queries.getquery",
- "parameterOrder": [
- "queryId"
- ],
- "parameters": {
- "queryId": {
- "description": "Query ID to retrieve.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "query/{queryId}",
- "response": {
- "$ref": "Query"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- },
- "listqueries": {
- "description": "Retrieves stored queries.",
- "flatPath": "queries",
- "httpMethod": "GET",
- "id": "doubleclickbidmanager.queries.listqueries",
- "parameterOrder": [],
- "parameters": {
- "pageSize": {
- "description": "Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Optional pagination token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "queries",
- "response": {
- "$ref": "ListQueriesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- },
- "runquery": {
- "description": "Runs a stored query to generate a report.",
- "flatPath": "query/{queryId}",
- "httpMethod": "POST",
- "id": "doubleclickbidmanager.queries.runquery",
- "parameterOrder": [
- "queryId"
- ],
- "parameters": {
- "asynchronous": {
- "default": "false",
- "description": "If true, tries to run the query asynchronously.",
- "location": "query",
- "type": "boolean"
- },
- "queryId": {
- "description": "Query ID to run.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "query/{queryId}",
- "request": {
- "$ref": "RunQueryRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- }
- }
+ "metadata": {
+ "$ref": "QueryMetadata",
+ "description": "Query metadata."
},
- "reports": {
- "methods": {
- "listreports": {
- "description": "Retrieves stored reports.",
- "flatPath": "queries/{queryId}/reports",
- "httpMethod": "GET",
- "id": "doubleclickbidmanager.reports.listreports",
- "parameterOrder": [
- "queryId"
- ],
- "parameters": {
- "pageSize": {
- "description": "Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Optional pagination token.",
- "location": "query",
- "type": "string"
- },
- "queryId": {
- "description": "Query ID with which the reports are associated.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "queries/{queryId}/reports",
- "response": {
- "$ref": "ListReportsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- }
- }
+ "params": {
+ "$ref": "Parameters",
+ "description": "Query parameters."
},
- "sdf": {
- "methods": {
- "download": {
- "description": "Retrieves entities in SDF format.",
- "flatPath": "sdf/download",
- "httpMethod": "POST",
- "id": "doubleclickbidmanager.sdf.download",
- "parameterOrder": [],
- "parameters": {},
- "path": "sdf/download",
- "request": {
- "$ref": "DownloadRequest"
- },
- "response": {
- "$ref": "DownloadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ]
- }
- }
- }
- },
- "revision": "20210315",
- "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
- "schemas": {
- "ChannelGrouping": {
- "description": "A channel grouping defines a set of rules that can be used to categorize events in a path report.",
- "id": "ChannelGrouping",
- "properties": {
- "fallbackName": {
- "description": "The name to apply to an event that does not match any of the rules in the channel grouping.",
- "type": "string"
- },
- "name": {
- "description": "Channel Grouping name.",
- "type": "string"
- },
- "rules": {
- "description": "Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "queryId": {
+ "description": "Query ID.",
+ "format": "int64",
+ "type": "string"
},
- "DisjunctiveMatchStatement": {
- "description": "DisjunctiveMatchStatement that OR's all contained filters.",
- "id": "DisjunctiveMatchStatement",
- "properties": {
- "eventFilters": {
- "description": "Filters. There is a limit of 100 filters that can be set per disjunctive match statement.",
- "items": {
- "$ref": "EventFilter"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
},
- "DownloadLineItemsRequest": {
- "description": "Request to fetch stored line items.",
- "id": "DownloadLineItemsRequest",
- "properties": {
- "fileSpec": {
- "description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
- "enum": [
- "EWF"
- ],
- "enumDescriptions": [
- ""
- ],
- "type": "string"
- },
- "filterIds": {
- "description": "Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "filterType": {
- "description": "Filter type used to filter line items to fetch.",
- "enum": [
- "ADVERTISER_ID",
- "INSERTION_ORDER_ID",
- "LINE_ITEM_ID"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "format": {
- "description": "Format in which the line items will be returned. Default to CSV.",
- "enum": [
- "CSV"
- ],
- "enumDescriptions": [
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
},
- "DownloadLineItemsResponse": {
- "description": "Download line items response.",
- "id": "DownloadLineItemsResponse",
- "properties": {
- "lineItems": {
- "description": "Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.",
- "type": "string"
- }
- },
- "type": "object"
+ "schedule": {
+ "$ref": "QuerySchedule",
+ "description": "Information on how often and when to run a query."
},
- "DownloadRequest": {
- "description": "Request to fetch stored inventory sources, campaigns, insertion orders, line items, YouTube ad groups and ads.",
- "id": "DownloadRequest",
- "properties": {
- "fileTypes": {
- "description": "File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - \"AD\" - \"AD_GROUP\" - \"CAMPAIGN\" - \"INSERTION_ORDER\" - \"INVENTORY_SOURCE\" - \"LINE_ITEM\" ",
- "items": {
- "enum": [
- "INSERTION_ORDER",
- "LINE_ITEM",
- "AD_GROUP",
- "AD",
- "CAMPAIGN",
- "INVENTORY_SOURCE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "filterIds": {
- "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "filterType": {
- "description": "Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources.",
- "enum": [
- "ADVERTISER_ID",
- "INSERTION_ORDER_ID",
- "LINE_ITEM_ID",
- "CAMPAIGN_ID",
- "INVENTORY_SOURCE_ID",
- "PARTNER_ID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "version": {
- "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 5.",
- "type": "string"
- }
- },
- "type": "object"
+ "timezoneCode": {
+ "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QueryMetadata": {
+ "description": "Query metadata.",
+ "id": "QueryMetadata",
+ "properties": {
+ "dataRange": {
+ "description": "Range of report data.",
+ "enum": [
+ "CUSTOM_DATES",
+ "CURRENT_DAY",
+ "PREVIOUS_DAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_HALF_MONTH",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "ALL_TIME",
+ "LAST_14_DAYS",
+ "TYPE_NOT_SUPPORTED",
+ "LAST_60_DAYS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "DownloadResponse": {
- "description": "Download response.",
- "id": "DownloadResponse",
- "properties": {
- "adGroups": {
- "description": "Retrieved ad groups in SDF format.",
- "type": "string"
- },
- "ads": {
- "description": "Retrieved ads in SDF format.",
- "type": "string"
- },
- "campaigns": {
- "description": "Retrieved campaigns in SDF format.",
- "type": "string"
- },
- "insertionOrders": {
- "description": "Retrieved insertion orders in SDF format.",
- "type": "string"
- },
- "inventorySources": {
- "type": "string"
- },
- "lineItems": {
- "description": "Retrieved line items in SDF format.",
- "type": "string"
- }
- },
- "type": "object"
+ "format": {
+ "description": "Format of the generated report.",
+ "enum": [
+ "CSV",
+ "EXCEL_CSV",
+ "XLSX"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "EventFilter": {
- "description": "Defines the type of filter to be applied to the path, a DV360 event dimension filter.",
- "id": "EventFilter",
- "properties": {
- "dimensionFilter": {
- "$ref": "PathQueryOptionsFilter",
- "description": "Filter on a dimension."
- }
- },
- "type": "object"
+ "googleCloudStoragePathForLatestReport": {
+ "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
+ "type": "string"
},
- "FilterPair": {
- "description": "Filter used to match traffic data in your report.",
- "id": "FilterPair",
- "properties": {
- "type": {
- "description": "Filter type.",
- "enum": [
- "FILTER_UNKNOWN",
- "FILTER_DATE",
- "FILTER_DAY_OF_WEEK",
- "FILTER_WEEK",
- "FILTER_MONTH",
- "FILTER_YEAR",
- "FILTER_TIME_OF_DAY",
- "FILTER_CONVERSION_DELAY",
- "FILTER_CREATIVE_ID",
- "FILTER_CREATIVE_SIZE",
- "FILTER_CREATIVE_TYPE",
- "FILTER_EXCHANGE_ID",
- "FILTER_AD_POSITION",
- "FILTER_PUBLIC_INVENTORY",
- "FILTER_INVENTORY_SOURCE",
- "FILTER_CITY",
- "FILTER_REGION",
- "FILTER_DMA",
- "FILTER_COUNTRY",
- "FILTER_SITE_ID",
- "FILTER_CHANNEL_ID",
- "FILTER_PARTNER",
- "FILTER_ADVERTISER",
- "FILTER_INSERTION_ORDER",
- "FILTER_LINE_ITEM",
- "FILTER_PARTNER_CURRENCY",
- "FILTER_ADVERTISER_CURRENCY",
- "FILTER_ADVERTISER_TIMEZONE",
- "FILTER_LINE_ITEM_TYPE",
- "FILTER_USER_LIST",
- "FILTER_USER_LIST_FIRST_PARTY",
- "FILTER_USER_LIST_THIRD_PARTY",
- "FILTER_TARGETED_USER_LIST",
- "FILTER_DATA_PROVIDER",
- "FILTER_ORDER_ID",
- "FILTER_VIDEO_PLAYER_SIZE",
- "FILTER_VIDEO_DURATION_SECONDS",
- "FILTER_KEYWORD",
- "FILTER_PAGE_CATEGORY",
- "FILTER_CAMPAIGN_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
- "FILTER_OS",
- "FILTER_BROWSER",
- "FILTER_CARRIER",
- "FILTER_SITE_LANGUAGE",
- "FILTER_INVENTORY_FORMAT",
- "FILTER_ZIP_CODE",
- "FILTER_VIDEO_RATING_TIER",
- "FILTER_VIDEO_FORMAT_SUPPORT",
- "FILTER_VIDEO_SKIPPABLE_SUPPORT",
- "FILTER_VIDEO_CREATIVE_DURATION",
- "FILTER_PAGE_LAYOUT",
- "FILTER_VIDEO_AD_POSITION_IN_STREAM",
- "FILTER_AGE",
- "FILTER_GENDER",
- "FILTER_QUARTER",
- "FILTER_TRUEVIEW_CONVERSION_TYPE",
- "FILTER_MOBILE_GEO",
- "FILTER_MRAID_SUPPORT",
- "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
- "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
- "FILTER_NIELSEN_COUNTRY_CODE",
- "FILTER_NIELSEN_DEVICE_ID",
- "FILTER_NIELSEN_GENDER",
- "FILTER_NIELSEN_AGE",
- "FILTER_INVENTORY_SOURCE_TYPE",
- "FILTER_CREATIVE_WIDTH",
- "FILTER_CREATIVE_HEIGHT",
- "FILTER_DFP_ORDER_ID",
- "FILTER_TRUEVIEW_AGE",
- "FILTER_TRUEVIEW_GENDER",
- "FILTER_TRUEVIEW_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_REMARKETING_LIST",
- "FILTER_TRUEVIEW_INTEREST",
- "FILTER_TRUEVIEW_AD_GROUP_ID",
- "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
- "FILTER_TRUEVIEW_IAR_LANGUAGE",
- "FILTER_TRUEVIEW_IAR_GENDER",
- "FILTER_TRUEVIEW_IAR_AGE",
- "FILTER_TRUEVIEW_IAR_CATEGORY",
- "FILTER_TRUEVIEW_IAR_COUNTRY",
- "FILTER_TRUEVIEW_IAR_CITY",
- "FILTER_TRUEVIEW_IAR_REGION",
- "FILTER_TRUEVIEW_IAR_ZIPCODE",
- "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
- "FILTER_TRUEVIEW_IAR_INTEREST",
- "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
- "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
- "FILTER_TRUEVIEW_CATEGORY",
- "FILTER_TRUEVIEW_KEYWORD",
- "FILTER_TRUEVIEW_PLACEMENT",
- "FILTER_TRUEVIEW_URL",
- "FILTER_TRUEVIEW_COUNTRY",
- "FILTER_TRUEVIEW_REGION",
- "FILTER_TRUEVIEW_CITY",
- "FILTER_TRUEVIEW_DMA",
- "FILTER_TRUEVIEW_ZIPCODE",
- "FILTER_NOT_SUPPORTED",
- "FILTER_MEDIA_PLAN",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
- "FILTER_SKIPPABLE_SUPPORT",
- "FILTER_COMPANION_CREATIVE_ID",
- "FILTER_BUDGET_SEGMENT_DESCRIPTION",
- "FILTER_FLOODLIGHT_ACTIVITY_ID",
- "FILTER_DEVICE_MODEL",
- "FILTER_DEVICE_MAKE",
- "FILTER_DEVICE_TYPE",
- "FILTER_CREATIVE_ATTRIBUTE",
- "FILTER_INVENTORY_COMMITMENT_TYPE",
- "FILTER_INVENTORY_RATE_TYPE",
- "FILTER_INVENTORY_DELIVERY_METHOD",
- "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
- "FILTER_AUTHORIZED_SELLER_STATE",
- "FILTER_VIDEO_DURATION_SECONDS_RANGE",
- "FILTER_PARTNER_NAME",
- "FILTER_PARTNER_STATUS",
- "FILTER_ADVERTISER_NAME",
- "FILTER_ADVERTISER_INTEGRATION_CODE",
- "FILTER_ADVERTISER_INTEGRATION_STATUS",
- "FILTER_CARRIER_NAME",
- "FILTER_CHANNEL_NAME",
- "FILTER_CITY_NAME",
- "FILTER_COMPANION_CREATIVE_NAME",
- "FILTER_USER_LIST_FIRST_PARTY_NAME",
- "FILTER_USER_LIST_THIRD_PARTY_NAME",
- "FILTER_NIELSEN_RESTATEMENT_DATE",
- "FILTER_NIELSEN_DATE_RANGE",
- "FILTER_INSERTION_ORDER_NAME",
- "FILTER_REGION_NAME",
- "FILTER_DMA_NAME",
- "FILTER_TRUEVIEW_IAR_REGION_NAME",
- "FILTER_TRUEVIEW_DMA_NAME",
- "FILTER_TRUEVIEW_REGION_NAME",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
- "FILTER_AD_TYPE",
- "FILTER_ALGORITHM",
- "FILTER_ALGORITHM_ID",
- "FILTER_AMP_PAGE_REQUEST",
- "FILTER_ANONYMOUS_INVENTORY_MODELING",
- "FILTER_APP_URL",
- "FILTER_APP_URL_EXCLUDED",
- "FILTER_ATTRIBUTED_USERLIST",
- "FILTER_ATTRIBUTED_USERLIST_COST",
- "FILTER_ATTRIBUTED_USERLIST_TYPE",
- "FILTER_ATTRIBUTION_MODEL",
- "FILTER_AUDIENCE_LIST",
- "FILTER_AUDIENCE_LIST_COST",
- "FILTER_AUDIENCE_LIST_TYPE",
- "FILTER_AUDIENCE_NAME",
- "FILTER_AUDIENCE_TYPE",
- "FILTER_BILLABLE_OUTCOME",
- "FILTER_BRAND_LIFT_TYPE",
- "FILTER_CHANNEL_TYPE",
- "FILTER_CM_PLACEMENT_ID",
- "FILTER_CONVERSION_SOURCE",
- "FILTER_CONVERSION_SOURCE_ID",
- "FILTER_COUNTRY_ID",
- "FILTER_CREATIVE",
- "FILTER_CREATIVE_ASSET",
- "FILTER_CREATIVE_INTEGRATION_CODE",
- "FILTER_CREATIVE_RENDERED_IN_AMP",
- "FILTER_CREATIVE_SOURCE",
- "FILTER_CREATIVE_STATUS",
- "FILTER_DATA_PROVIDER_NAME",
- "FILTER_DETAILED_DEMOGRAPHICS",
- "FILTER_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_DEVICE",
- "FILTER_GAM_INSERTION_ORDER",
- "FILTER_GAM_LINE_ITEM",
- "FILTER_GAM_LINE_ITEM_ID",
- "FILTER_DIGITAL_CONTENT_LABEL",
- "FILTER_DOMAIN",
- "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
- "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
- "FILTER_EXCHANGE",
- "FILTER_EXCHANGE_CODE",
- "FILTER_EXTENSION",
- "FILTER_EXTENSION_STATUS",
- "FILTER_EXTENSION_TYPE",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_FLOODLIGHT_ACTIVITY",
- "FILTER_FORMAT",
- "FILTER_GMAIL_AGE",
- "FILTER_GMAIL_CITY",
- "FILTER_GMAIL_COUNTRY",
- "FILTER_GMAIL_COUNTRY_NAME",
- "FILTER_GMAIL_DEVICE_TYPE",
- "FILTER_GMAIL_DEVICE_TYPE_NAME",
- "FILTER_GMAIL_GENDER",
- "FILTER_GMAIL_REGION",
- "FILTER_GMAIL_REMARKETING_LIST",
- "FILTER_HOUSEHOLD_INCOME",
- "FILTER_IMPRESSION_COUNTING_METHOD",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
- "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
- "FILTER_INSERTION_ORDER_STATUS",
- "FILTER_INTEREST",
- "FILTER_INVENTORY_SOURCE_GROUP",
- "FILTER_INVENTORY_SOURCE_GROUP_ID",
- "FILTER_INVENTORY_SOURCE_ID",
- "FILTER_INVENTORY_SOURCE_NAME",
- "FILTER_LIFE_EVENT",
- "FILTER_LIFE_EVENTS",
- "FILTER_LINE_ITEM_INTEGRATION_CODE",
- "FILTER_LINE_ITEM_NAME",
- "FILTER_LINE_ITEM_STATUS",
- "FILTER_MATCH_RATIO",
- "FILTER_MEASUREMENT_SOURCE",
- "FILTER_MEDIA_PLAN_NAME",
- "FILTER_PARENTAL_STATUS",
- "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
- "FILTER_PLATFORM",
- "FILTER_PLAYBACK_METHOD",
- "FILTER_POSITION_IN_CONTENT",
- "FILTER_PUBLISHER_PROPERTY",
- "FILTER_PUBLISHER_PROPERTY_ID",
- "FILTER_PUBLISHER_PROPERTY_SECTION",
- "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
- "FILTER_REFUND_REASON",
- "FILTER_REMARKETING_LIST",
- "FILTER_REWARDED",
- "FILTER_SENSITIVE_CATEGORY",
- "FILTER_SERVED_PIXEL_DENSITY",
- "FILTER_TARGETED_DATA_PROVIDERS",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_TRUEVIEW_AD",
- "FILTER_TRUEVIEW_AD_GROUP",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
- "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
- "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
- "FILTER_VARIANT_ID",
- "FILTER_VARIANT_NAME",
- "FILTER_VARIANT_VERSION",
- "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
- "FILTER_VERIFICATION_VIDEO_POSITION",
- "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
- "FILTER_VIDEO_CONTINUOUS_PLAY",
- "FILTER_VIDEO_DURATION",
- "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
- "FILTER_YOUTUBE_AD_VIDEO",
- "FILTER_YOUTUBE_AD_VIDEO_ID",
- "FILTER_YOUTUBE_CHANNEL",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
- "FILTER_YOUTUBE_VIDEO",
- "FILTER_ZIP_POSTAL_CODE",
- "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
- "FILTER_TRUEVIEW_PLACEMENT_ID",
- "FILTER_PATH_PATTERN_ID",
- "FILTER_PATH_EVENT_INDEX",
- "FILTER_EVENT_TYPE",
- "FILTER_CHANNEL_GROUPING",
- "FILTER_OM_SDK_AVAILABLE",
- "FILTER_DATA_SOURCE",
- "FILTER_CM360_PLACEMENT_ID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "value": {
- "description": "Filter value.",
- "type": "string"
- }
- },
- "type": "object"
+ "googleDrivePathForLatestReport": {
+ "description": "The path in Google Drive for the latest report.",
+ "type": "string"
},
- "ListQueriesResponse": {
- "description": "List queries response.",
- "id": "ListQueriesResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Next page's pagination token if one exists.",
- "type": "string"
- },
- "queries": {
- "description": "Retrieved queries.",
- "items": {
- "$ref": "Query"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "latestReportRunTimeMs": {
+ "description": "The time when the latest report started to run.",
+ "format": "int64",
+ "type": "string"
},
- "ListReportsResponse": {
- "description": "List reports response.",
- "id": "ListReportsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "Next page's pagination token if one exists.",
- "type": "string"
- },
- "reports": {
- "description": "Retrieved reports.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "locale": {
+ "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.",
+ "type": "string"
},
- "Options": {
- "description": "Additional query options.",
- "id": "Options",
- "properties": {
- "includeOnlyTargetedUserLists": {
- "description": "Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.",
- "type": "boolean"
- },
- "pathQueryOptions": {
- "$ref": "PathQueryOptions",
- "description": "Options that contain Path Filters and Custom Channel Groupings."
- }
- },
- "type": "object"
+ "reportCount": {
+ "description": "Number of reports that have been generated for the query.",
+ "format": "int32",
+ "type": "integer"
},
- "Parameters": {
- "description": "Parameters of a query or report.",
- "id": "Parameters",
- "properties": {
- "filters": {
- "description": "Filters used to match traffic data in your report.",
- "items": {
- "$ref": "FilterPair"
- },
- "type": "array"
- },
- "groupBys": {
- "description": "Data is grouped by the filters listed in this field.",
- "items": {
- "enum": [
- "FILTER_UNKNOWN",
- "FILTER_DATE",
- "FILTER_DAY_OF_WEEK",
- "FILTER_WEEK",
- "FILTER_MONTH",
- "FILTER_YEAR",
- "FILTER_TIME_OF_DAY",
- "FILTER_CONVERSION_DELAY",
- "FILTER_CREATIVE_ID",
- "FILTER_CREATIVE_SIZE",
- "FILTER_CREATIVE_TYPE",
- "FILTER_EXCHANGE_ID",
- "FILTER_AD_POSITION",
- "FILTER_PUBLIC_INVENTORY",
- "FILTER_INVENTORY_SOURCE",
- "FILTER_CITY",
- "FILTER_REGION",
- "FILTER_DMA",
- "FILTER_COUNTRY",
- "FILTER_SITE_ID",
- "FILTER_CHANNEL_ID",
- "FILTER_PARTNER",
- "FILTER_ADVERTISER",
- "FILTER_INSERTION_ORDER",
- "FILTER_LINE_ITEM",
- "FILTER_PARTNER_CURRENCY",
- "FILTER_ADVERTISER_CURRENCY",
- "FILTER_ADVERTISER_TIMEZONE",
- "FILTER_LINE_ITEM_TYPE",
- "FILTER_USER_LIST",
- "FILTER_USER_LIST_FIRST_PARTY",
- "FILTER_USER_LIST_THIRD_PARTY",
- "FILTER_TARGETED_USER_LIST",
- "FILTER_DATA_PROVIDER",
- "FILTER_ORDER_ID",
- "FILTER_VIDEO_PLAYER_SIZE",
- "FILTER_VIDEO_DURATION_SECONDS",
- "FILTER_KEYWORD",
- "FILTER_PAGE_CATEGORY",
- "FILTER_CAMPAIGN_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
- "FILTER_OS",
- "FILTER_BROWSER",
- "FILTER_CARRIER",
- "FILTER_SITE_LANGUAGE",
- "FILTER_INVENTORY_FORMAT",
- "FILTER_ZIP_CODE",
- "FILTER_VIDEO_RATING_TIER",
- "FILTER_VIDEO_FORMAT_SUPPORT",
- "FILTER_VIDEO_SKIPPABLE_SUPPORT",
- "FILTER_VIDEO_CREATIVE_DURATION",
- "FILTER_PAGE_LAYOUT",
- "FILTER_VIDEO_AD_POSITION_IN_STREAM",
- "FILTER_AGE",
- "FILTER_GENDER",
- "FILTER_QUARTER",
- "FILTER_TRUEVIEW_CONVERSION_TYPE",
- "FILTER_MOBILE_GEO",
- "FILTER_MRAID_SUPPORT",
- "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
- "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
- "FILTER_NIELSEN_COUNTRY_CODE",
- "FILTER_NIELSEN_DEVICE_ID",
- "FILTER_NIELSEN_GENDER",
- "FILTER_NIELSEN_AGE",
- "FILTER_INVENTORY_SOURCE_TYPE",
- "FILTER_CREATIVE_WIDTH",
- "FILTER_CREATIVE_HEIGHT",
- "FILTER_DFP_ORDER_ID",
- "FILTER_TRUEVIEW_AGE",
- "FILTER_TRUEVIEW_GENDER",
- "FILTER_TRUEVIEW_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_REMARKETING_LIST",
- "FILTER_TRUEVIEW_INTEREST",
- "FILTER_TRUEVIEW_AD_GROUP_ID",
- "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
- "FILTER_TRUEVIEW_IAR_LANGUAGE",
- "FILTER_TRUEVIEW_IAR_GENDER",
- "FILTER_TRUEVIEW_IAR_AGE",
- "FILTER_TRUEVIEW_IAR_CATEGORY",
- "FILTER_TRUEVIEW_IAR_COUNTRY",
- "FILTER_TRUEVIEW_IAR_CITY",
- "FILTER_TRUEVIEW_IAR_REGION",
- "FILTER_TRUEVIEW_IAR_ZIPCODE",
- "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
- "FILTER_TRUEVIEW_IAR_INTEREST",
- "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
- "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
- "FILTER_TRUEVIEW_CATEGORY",
- "FILTER_TRUEVIEW_KEYWORD",
- "FILTER_TRUEVIEW_PLACEMENT",
- "FILTER_TRUEVIEW_URL",
- "FILTER_TRUEVIEW_COUNTRY",
- "FILTER_TRUEVIEW_REGION",
- "FILTER_TRUEVIEW_CITY",
- "FILTER_TRUEVIEW_DMA",
- "FILTER_TRUEVIEW_ZIPCODE",
- "FILTER_NOT_SUPPORTED",
- "FILTER_MEDIA_PLAN",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
- "FILTER_SKIPPABLE_SUPPORT",
- "FILTER_COMPANION_CREATIVE_ID",
- "FILTER_BUDGET_SEGMENT_DESCRIPTION",
- "FILTER_FLOODLIGHT_ACTIVITY_ID",
- "FILTER_DEVICE_MODEL",
- "FILTER_DEVICE_MAKE",
- "FILTER_DEVICE_TYPE",
- "FILTER_CREATIVE_ATTRIBUTE",
- "FILTER_INVENTORY_COMMITMENT_TYPE",
- "FILTER_INVENTORY_RATE_TYPE",
- "FILTER_INVENTORY_DELIVERY_METHOD",
- "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
- "FILTER_AUTHORIZED_SELLER_STATE",
- "FILTER_VIDEO_DURATION_SECONDS_RANGE",
- "FILTER_PARTNER_NAME",
- "FILTER_PARTNER_STATUS",
- "FILTER_ADVERTISER_NAME",
- "FILTER_ADVERTISER_INTEGRATION_CODE",
- "FILTER_ADVERTISER_INTEGRATION_STATUS",
- "FILTER_CARRIER_NAME",
- "FILTER_CHANNEL_NAME",
- "FILTER_CITY_NAME",
- "FILTER_COMPANION_CREATIVE_NAME",
- "FILTER_USER_LIST_FIRST_PARTY_NAME",
- "FILTER_USER_LIST_THIRD_PARTY_NAME",
- "FILTER_NIELSEN_RESTATEMENT_DATE",
- "FILTER_NIELSEN_DATE_RANGE",
- "FILTER_INSERTION_ORDER_NAME",
- "FILTER_REGION_NAME",
- "FILTER_DMA_NAME",
- "FILTER_TRUEVIEW_IAR_REGION_NAME",
- "FILTER_TRUEVIEW_DMA_NAME",
- "FILTER_TRUEVIEW_REGION_NAME",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
- "FILTER_AD_TYPE",
- "FILTER_ALGORITHM",
- "FILTER_ALGORITHM_ID",
- "FILTER_AMP_PAGE_REQUEST",
- "FILTER_ANONYMOUS_INVENTORY_MODELING",
- "FILTER_APP_URL",
- "FILTER_APP_URL_EXCLUDED",
- "FILTER_ATTRIBUTED_USERLIST",
- "FILTER_ATTRIBUTED_USERLIST_COST",
- "FILTER_ATTRIBUTED_USERLIST_TYPE",
- "FILTER_ATTRIBUTION_MODEL",
- "FILTER_AUDIENCE_LIST",
- "FILTER_AUDIENCE_LIST_COST",
- "FILTER_AUDIENCE_LIST_TYPE",
- "FILTER_AUDIENCE_NAME",
- "FILTER_AUDIENCE_TYPE",
- "FILTER_BILLABLE_OUTCOME",
- "FILTER_BRAND_LIFT_TYPE",
- "FILTER_CHANNEL_TYPE",
- "FILTER_CM_PLACEMENT_ID",
- "FILTER_CONVERSION_SOURCE",
- "FILTER_CONVERSION_SOURCE_ID",
- "FILTER_COUNTRY_ID",
- "FILTER_CREATIVE",
- "FILTER_CREATIVE_ASSET",
- "FILTER_CREATIVE_INTEGRATION_CODE",
- "FILTER_CREATIVE_RENDERED_IN_AMP",
- "FILTER_CREATIVE_SOURCE",
- "FILTER_CREATIVE_STATUS",
- "FILTER_DATA_PROVIDER_NAME",
- "FILTER_DETAILED_DEMOGRAPHICS",
- "FILTER_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_DEVICE",
- "FILTER_GAM_INSERTION_ORDER",
- "FILTER_GAM_LINE_ITEM",
- "FILTER_GAM_LINE_ITEM_ID",
- "FILTER_DIGITAL_CONTENT_LABEL",
- "FILTER_DOMAIN",
- "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
- "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
- "FILTER_EXCHANGE",
- "FILTER_EXCHANGE_CODE",
- "FILTER_EXTENSION",
- "FILTER_EXTENSION_STATUS",
- "FILTER_EXTENSION_TYPE",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_FLOODLIGHT_ACTIVITY",
- "FILTER_FORMAT",
- "FILTER_GMAIL_AGE",
- "FILTER_GMAIL_CITY",
- "FILTER_GMAIL_COUNTRY",
- "FILTER_GMAIL_COUNTRY_NAME",
- "FILTER_GMAIL_DEVICE_TYPE",
- "FILTER_GMAIL_DEVICE_TYPE_NAME",
- "FILTER_GMAIL_GENDER",
- "FILTER_GMAIL_REGION",
- "FILTER_GMAIL_REMARKETING_LIST",
- "FILTER_HOUSEHOLD_INCOME",
- "FILTER_IMPRESSION_COUNTING_METHOD",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
- "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
- "FILTER_INSERTION_ORDER_STATUS",
- "FILTER_INTEREST",
- "FILTER_INVENTORY_SOURCE_GROUP",
- "FILTER_INVENTORY_SOURCE_GROUP_ID",
- "FILTER_INVENTORY_SOURCE_ID",
- "FILTER_INVENTORY_SOURCE_NAME",
- "FILTER_LIFE_EVENT",
- "FILTER_LIFE_EVENTS",
- "FILTER_LINE_ITEM_INTEGRATION_CODE",
- "FILTER_LINE_ITEM_NAME",
- "FILTER_LINE_ITEM_STATUS",
- "FILTER_MATCH_RATIO",
- "FILTER_MEASUREMENT_SOURCE",
- "FILTER_MEDIA_PLAN_NAME",
- "FILTER_PARENTAL_STATUS",
- "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
- "FILTER_PLATFORM",
- "FILTER_PLAYBACK_METHOD",
- "FILTER_POSITION_IN_CONTENT",
- "FILTER_PUBLISHER_PROPERTY",
- "FILTER_PUBLISHER_PROPERTY_ID",
- "FILTER_PUBLISHER_PROPERTY_SECTION",
- "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
- "FILTER_REFUND_REASON",
- "FILTER_REMARKETING_LIST",
- "FILTER_REWARDED",
- "FILTER_SENSITIVE_CATEGORY",
- "FILTER_SERVED_PIXEL_DENSITY",
- "FILTER_TARGETED_DATA_PROVIDERS",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_TRUEVIEW_AD",
- "FILTER_TRUEVIEW_AD_GROUP",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
- "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
- "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
- "FILTER_VARIANT_ID",
- "FILTER_VARIANT_NAME",
- "FILTER_VARIANT_VERSION",
- "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
- "FILTER_VERIFICATION_VIDEO_POSITION",
- "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
- "FILTER_VIDEO_CONTINUOUS_PLAY",
- "FILTER_VIDEO_DURATION",
- "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
- "FILTER_YOUTUBE_AD_VIDEO",
- "FILTER_YOUTUBE_AD_VIDEO_ID",
- "FILTER_YOUTUBE_CHANNEL",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
- "FILTER_YOUTUBE_VIDEO",
- "FILTER_ZIP_POSTAL_CODE",
- "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
- "FILTER_TRUEVIEW_PLACEMENT_ID",
- "FILTER_PATH_PATTERN_ID",
- "FILTER_PATH_EVENT_INDEX",
- "FILTER_EVENT_TYPE",
- "FILTER_CHANNEL_GROUPING",
- "FILTER_OM_SDK_AVAILABLE",
- "FILTER_DATA_SOURCE",
- "FILTER_CM360_PLACEMENT_ID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "includeInviteData": {
- "description": "Deprecated. This field is no longer in use.",
- "type": "boolean"
- },
- "metrics": {
- "description": "Metrics to include as columns in your report.",
- "items": {
- "enum": [
- "METRIC_UNKNOWN",
- "METRIC_IMPRESSIONS",
- "METRIC_CLICKS",
- "METRIC_LAST_IMPRESSIONS",
- "METRIC_LAST_CLICKS",
- "METRIC_TOTAL_CONVERSIONS",
- "METRIC_MEDIA_COST_ADVERTISER",
- "METRIC_MEDIA_COST_USD",
- "METRIC_MEDIA_COST_PARTNER",
- "METRIC_DATA_COST_ADVERTISER",
- "METRIC_DATA_COST_USD",
- "METRIC_DATA_COST_PARTNER",
- "METRIC_CPM_FEE1_ADVERTISER",
- "METRIC_CPM_FEE1_USD",
- "METRIC_CPM_FEE1_PARTNER",
- "METRIC_CPM_FEE2_ADVERTISER",
- "METRIC_CPM_FEE2_USD",
- "METRIC_CPM_FEE2_PARTNER",
- "METRIC_MEDIA_FEE1_ADVERTISER",
- "METRIC_MEDIA_FEE1_USD",
- "METRIC_MEDIA_FEE1_PARTNER",
- "METRIC_MEDIA_FEE2_ADVERTISER",
- "METRIC_MEDIA_FEE2_USD",
- "METRIC_MEDIA_FEE2_PARTNER",
- "METRIC_REVENUE_ADVERTISER",
- "METRIC_REVENUE_USD",
- "METRIC_REVENUE_PARTNER",
- "METRIC_PROFIT_ADVERTISER",
- "METRIC_PROFIT_USD",
- "METRIC_PROFIT_PARTNER",
- "METRIC_PROFIT_MARGIN",
- "METRIC_TOTAL_MEDIA_COST_USD",
- "METRIC_TOTAL_MEDIA_COST_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ADVERTISER",
- "METRIC_BILLABLE_COST_USD",
- "METRIC_BILLABLE_COST_PARTNER",
- "METRIC_BILLABLE_COST_ADVERTISER",
- "METRIC_PLATFORM_FEE_USD",
- "METRIC_PLATFORM_FEE_PARTNER",
- "METRIC_PLATFORM_FEE_ADVERTISER",
- "METRIC_VIDEO_COMPLETION_RATE",
- "METRIC_PROFIT_ECPM_ADVERTISER",
- "METRIC_PROFIT_ECPM_USD",
- "METRIC_PROFIT_ECPM_PARTNER",
- "METRIC_REVENUE_ECPM_ADVERTISER",
- "METRIC_REVENUE_ECPM_USD",
- "METRIC_REVENUE_ECPM_PARTNER",
- "METRIC_REVENUE_ECPC_ADVERTISER",
- "METRIC_REVENUE_ECPC_USD",
- "METRIC_REVENUE_ECPC_PARTNER",
- "METRIC_REVENUE_ECPA_ADVERTISER",
- "METRIC_REVENUE_ECPA_USD",
- "METRIC_REVENUE_ECPA_PARTNER",
- "METRIC_REVENUE_ECPAPV_ADVERTISER",
- "METRIC_REVENUE_ECPAPV_USD",
- "METRIC_REVENUE_ECPAPV_PARTNER",
- "METRIC_REVENUE_ECPAPC_ADVERTISER",
- "METRIC_REVENUE_ECPAPC_USD",
- "METRIC_REVENUE_ECPAPC_PARTNER",
- "METRIC_MEDIA_COST_ECPM_ADVERTISER",
- "METRIC_MEDIA_COST_ECPM_USD",
- "METRIC_MEDIA_COST_ECPM_PARTNER",
- "METRIC_MEDIA_COST_ECPC_ADVERTISER",
- "METRIC_MEDIA_COST_ECPC_USD",
- "METRIC_MEDIA_COST_ECPC_PARTNER",
- "METRIC_MEDIA_COST_ECPA_ADVERTISER",
- "METRIC_MEDIA_COST_ECPA_USD",
- "METRIC_MEDIA_COST_ECPA_PARTNER",
- "METRIC_MEDIA_COST_ECPAPV_ADVERTISER",
- "METRIC_MEDIA_COST_ECPAPV_USD",
- "METRIC_MEDIA_COST_ECPAPV_PARTNER",
- "METRIC_MEDIA_COST_ECPAPC_ADVERTISER",
- "METRIC_MEDIA_COST_ECPAPC_USD",
- "METRIC_MEDIA_COST_ECPAPC_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPM_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPC_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPA_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER",
- "METRIC_RICH_MEDIA_VIDEO_PLAYS",
- "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS",
- "METRIC_RICH_MEDIA_VIDEO_PAUSES",
- "METRIC_RICH_MEDIA_VIDEO_MUTES",
- "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS",
- "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS",
- "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES",
- "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES",
- "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE",
- "METRIC_IMPRESSIONS_TO_CONVERSION_RATE",
- "METRIC_CONVERSIONS_PER_MILLE",
- "METRIC_CTR",
- "METRIC_BID_REQUESTS",
- "METRIC_UNIQUE_VISITORS_COOKIES",
- "METRIC_REVENUE_ECPCV_ADVERTISER",
- "METRIC_REVENUE_ECPCV_USD",
- "METRIC_REVENUE_ECPCV_PARTNER",
- "METRIC_MEDIA_COST_ECPCV_ADVERTISER",
- "METRIC_MEDIA_COST_ECPCV_USD",
- "METRIC_MEDIA_COST_ECPCV_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_ECPCV_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_ECPCV_USD",
- "METRIC_TOTAL_MEDIA_COST_ECPCV_PARTNER",
- "METRIC_RICH_MEDIA_VIDEO_SKIPS",
- "METRIC_FEE2_ADVERTISER",
- "METRIC_FEE2_USD",
- "METRIC_FEE2_PARTNER",
- "METRIC_FEE3_ADVERTISER",
- "METRIC_FEE3_USD",
- "METRIC_FEE3_PARTNER",
- "METRIC_FEE4_ADVERTISER",
- "METRIC_FEE4_USD",
- "METRIC_FEE4_PARTNER",
- "METRIC_FEE5_ADVERTISER",
- "METRIC_FEE5_USD",
- "METRIC_FEE5_PARTNER",
- "METRIC_FEE6_ADVERTISER",
- "METRIC_FEE6_USD",
- "METRIC_FEE6_PARTNER",
- "METRIC_FEE7_ADVERTISER",
- "METRIC_FEE7_USD",
- "METRIC_FEE7_PARTNER",
- "METRIC_FEE8_ADVERTISER",
- "METRIC_FEE8_USD",
- "METRIC_FEE8_PARTNER",
- "METRIC_FEE9_ADVERTISER",
- "METRIC_FEE9_USD",
- "METRIC_FEE9_PARTNER",
- "METRIC_FEE10_ADVERTISER",
- "METRIC_FEE10_USD",
- "METRIC_FEE10_PARTNER",
- "METRIC_FEE11_ADVERTISER",
- "METRIC_FEE11_USD",
- "METRIC_FEE11_PARTNER",
- "METRIC_FEE12_ADVERTISER",
- "METRIC_FEE12_USD",
- "METRIC_FEE12_PARTNER",
- "METRIC_FEE13_ADVERTISER",
- "METRIC_FEE13_USD",
- "METRIC_FEE13_PARTNER",
- "METRIC_FEE14_ADVERTISER",
- "METRIC_FEE14_USD",
- "METRIC_FEE14_PARTNER",
- "METRIC_FEE15_ADVERTISER",
- "METRIC_FEE15_USD",
- "METRIC_FEE15_PARTNER",
- "METRIC_CPM_FEE3_ADVERTISER",
- "METRIC_CPM_FEE3_USD",
- "METRIC_CPM_FEE3_PARTNER",
- "METRIC_CPM_FEE4_ADVERTISER",
- "METRIC_CPM_FEE4_USD",
- "METRIC_CPM_FEE4_PARTNER",
- "METRIC_CPM_FEE5_ADVERTISER",
- "METRIC_CPM_FEE5_USD",
- "METRIC_CPM_FEE5_PARTNER",
- "METRIC_MEDIA_FEE3_ADVERTISER",
- "METRIC_MEDIA_FEE3_USD",
- "METRIC_MEDIA_FEE3_PARTNER",
- "METRIC_MEDIA_FEE4_ADVERTISER",
- "METRIC_MEDIA_FEE4_USD",
- "METRIC_MEDIA_FEE4_PARTNER",
- "METRIC_MEDIA_FEE5_ADVERTISER",
- "METRIC_MEDIA_FEE5_USD",
- "METRIC_MEDIA_FEE5_PARTNER",
- "METRIC_VIDEO_COMPANION_IMPRESSIONS",
- "METRIC_VIDEO_COMPANION_CLICKS",
- "METRIC_FEE16_ADVERTISER",
- "METRIC_FEE16_USD",
- "METRIC_FEE16_PARTNER",
- "METRIC_FEE17_ADVERTISER",
- "METRIC_FEE17_USD",
- "METRIC_FEE17_PARTNER",
- "METRIC_FEE18_ADVERTISER",
- "METRIC_FEE18_USD",
- "METRIC_FEE18_PARTNER",
- "METRIC_TRUEVIEW_VIEWS",
- "METRIC_TRUEVIEW_UNIQUE_VIEWERS",
- "METRIC_TRUEVIEW_EARNED_VIEWS",
- "METRIC_TRUEVIEW_EARNED_SUBSCRIBERS",
- "METRIC_TRUEVIEW_EARNED_PLAYLIST_ADDITIONS",
- "METRIC_TRUEVIEW_EARNED_LIKES",
- "METRIC_TRUEVIEW_EARNED_SHARES",
- "METRIC_TRUEVIEW_IMPRESSION_SHARE",
- "METRIC_TRUEVIEW_LOST_IS_BUDGET",
- "METRIC_TRUEVIEW_LOST_IS_RANK",
- "METRIC_TRUEVIEW_VIEW_THROUGH_CONVERSION",
- "METRIC_TRUEVIEW_CONVERSION_MANY_PER_VIEW",
- "METRIC_TRUEVIEW_VIEW_RATE",
- "METRIC_TRUEVIEW_CONVERSION_RATE_ONE_PER_VIEW",
- "METRIC_TRUEVIEW_CPV_ADVERTISER",
- "METRIC_TRUEVIEW_CPV_USD",
- "METRIC_TRUEVIEW_CPV_PARTNER",
- "METRIC_FEE19_ADVERTISER",
- "METRIC_FEE19_USD",
- "METRIC_FEE19_PARTNER",
- "METRIC_TEA_TRUEVIEW_IMPRESSIONS",
- "METRIC_TEA_TRUEVIEW_UNIQUE_COOKIES",
- "METRIC_FEE20_ADVERTISER",
- "METRIC_FEE20_USD",
- "METRIC_FEE20_PARTNER",
- "METRIC_FEE21_ADVERTISER",
- "METRIC_FEE21_USD",
- "METRIC_FEE21_PARTNER",
- "METRIC_FEE22_ADVERTISER",
- "METRIC_FEE22_USD",
- "METRIC_FEE22_PARTNER",
- "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_ADVERTISER",
- "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_USD",
- "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_PARTNER",
- "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_ADVERTISER",
- "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_USD",
- "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_PARTNER",
- "METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER",
- "METRIC_PROFIT_VIEWABLE_ECPM_USD",
- "METRIC_PROFIT_VIEWABLE_ECPM_PARTNER",
- "METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER",
- "METRIC_REVENUE_VIEWABLE_ECPM_USD",
- "METRIC_REVENUE_VIEWABLE_ECPM_PARTNER",
- "METRIC_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
- "METRIC_MEDIA_COST_VIEWABLE_ECPM_USD",
- "METRIC_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
- "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
- "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_USD",
- "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
- "METRIC_TRUEVIEW_ENGAGEMENTS",
- "METRIC_TRUEVIEW_ENGAGEMENT_RATE",
- "METRIC_TRUEVIEW_AVERAGE_CPE_ADVERTISER",
- "METRIC_TRUEVIEW_AVERAGE_CPE_USD",
- "METRIC_TRUEVIEW_AVERAGE_CPE_PARTNER",
- "METRIC_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_PCT_MEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_PCT_VIEWABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME",
- "METRIC_ACTIVE_VIEW_UNMEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_UNVIEWABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNMEASURABLE",
- "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNVIEWABLE",
- "METRIC_ACTIVE_VIEW_DISTRIBUTION_VIEWABLE",
- "METRIC_ACTIVE_VIEW_PERCENT_VIEWABLE_FOR_TIME_THRESHOLD",
- "METRIC_ACTIVE_VIEW_VIEWABLE_FOR_TIME_THRESHOLD",
- "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_AT_START",
- "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_FIRST_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_SECOND_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_THIRD_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_ON_COMPLETE",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_AT_START",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_FIRST_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_SECOND_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_THIRD_QUAR",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_ON_COMPLETE",
- "METRIC_ACTIVE_VIEW_AUDIBLE_VISIBLE_ON_COMPLETE_IMPRESSIONS",
- "METRIC_VIEWABLE_BID_REQUESTS",
- "METRIC_COOKIE_REACH_IMPRESSION_REACH",
- "METRIC_COOKIE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
- "METRIC_DBM_ENGAGEMENT_RATE",
- "METRIC_RICH_MEDIA_SCROLLS",
- "METRIC_CM_POST_VIEW_REVENUE",
- "METRIC_CM_POST_CLICK_REVENUE",
- "METRIC_FLOODLIGHT_IMPRESSIONS",
- "METRIC_BILLABLE_IMPRESSIONS",
- "METRIC_NIELSEN_AVERAGE_FREQUENCY",
- "METRIC_NIELSEN_IMPRESSIONS",
- "METRIC_NIELSEN_UNIQUE_AUDIENCE",
- "METRIC_NIELSEN_GRP",
- "METRIC_NIELSEN_IMPRESSION_INDEX",
- "METRIC_NIELSEN_IMPRESSIONS_SHARE",
- "METRIC_NIELSEN_POPULATION",
- "METRIC_NIELSEN_POPULATION_REACH",
- "METRIC_NIELSEN_POPULATION_SHARE",
- "METRIC_NIELSEN_REACH_INDEX",
- "METRIC_NIELSEN_REACH_SHARE",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_MEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_RATE",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_MEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_AUDIBLE_FULLY_ON_SCREEN_HALF_OF_DURATION_TRUEVIEW_RATE",
- "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_MEASURABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_VIEWABLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_CUSTOM_METRIC_VIEWABLE_RATE",
- "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_IMPRESSIONS",
- "METRIC_ACTIVE_VIEW_PERCENT_FULLY_ON_SCREEN_2_SEC",
- "METRIC_ACTIVE_VIEW_PERCENT_FULL_SCREEN",
- "METRIC_ACTIVE_VIEW_PERCENT_IN_BACKGROUND",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_AD_PLAYED",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_COMPLETED_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_COMPLETED_IMPRESSIONS_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_FIRST_QUARTILE_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_FIRST_QUARTILE_IMPRESSIONS_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_MIDPOINT_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_MIDPOINT_IMPRESSIONS_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_THIRD_QUARTILE_IMPRESSIONS_AUDIBLE_AND_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_OF_THIRD_QUARTILE_IMPRESSIONS_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_AUDIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_AUDIBLE_AND_VISIBLE",
- "METRIC_ACTIVE_VIEW_PERCENT_PLAY_TIME_VISIBLE",
- "METRIC_ADAPTED_AUDIENCE_FREQUENCY",
- "METRIC_ADLINGO_FEE_ADVERTISER_CURRENCY",
- "METRIC_AUDIO_CLIENT_COST_ECPCL_ADVERTISER_CURRENCY",
- "METRIC_AUDIO_MEDIA_COST_ECPCL_ADVERTISER_CURRENCY",
- "METRIC_AUDIO_MUTES_AUDIO",
- "METRIC_AUDIO_REVENUE_ECPCL_ADVERTISER_CURRENCY",
- "METRIC_AUDIO_UNMUTES_AUDIO",
- "METRIC_AUDIO_UNMUTES_VIDEO",
- "METRIC_AVERAGE_DISPLAY_TIME",
- "METRIC_AVERAGE_IMPRESSION_FREQUENCY_PER_USER",
- "METRIC_AVERAGE_INTERACTION_TIME",
- "METRIC_AVERAGE_WATCH_TIME_PER_IMPRESSION",
- "METRIC_BEGIN_TO_RENDER_ELIGIBLE_IMPRESSIONS",
- "METRIC_BEGIN_TO_RENDER_IMPRESSIONS",
- "METRIC_BENCHMARK_FREQUENCY",
- "METRIC_BRAND_LIFT_ABSOLUTE_BRAND_LIFT",
- "METRIC_BRAND_LIFT_ALL_SURVEY_RESPONSES",
- "METRIC_BRAND_LIFT_BASELINE_POSITIVE_RESPONSE_RATE",
- "METRIC_BRAND_LIFT_BASELINE_SURVEY_RESPONSES",
- "METRIC_BRAND_LIFT_COST_PER_LIFTED_USER",
- "METRIC_BRAND_LIFT_EXPOSED_SURVEY_RESPONSES",
- "METRIC_BRAND_LIFT_HEADROOM_BRAND_LIFT",
- "METRIC_BRAND_LIFT_RELATIVE_BRAND_LIFT",
- "METRIC_BRAND_LIFT_USERS",
- "METRIC_CARD_CLICKS",
- "METRIC_CLIENT_COST_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_ECPA_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_ECPA_PC_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_ECPA_PV_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_ECPC_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_ECPM_ADVERTISER_CURRENCY",
- "METRIC_CLIENT_COST_VIEWABLE_ECPM_ADVERTISER_CURRENCY",
- "METRIC_CM_POST_CLICK_REVENUE_CROSS_ENVIRONMENT",
- "METRIC_CM_POST_VIEW_REVENUE_CROSS_ENVIRONMENT",
- "METRIC_COMPANION_CLICKS_AUDIO",
- "METRIC_COMPANION_IMPRESSIONS_AUDIO",
- "METRIC_COMPLETE_LISTENS_AUDIO",
- "METRIC_COMPLETION_RATE_AUDIO",
- "METRIC_COUNTERS",
- "METRIC_CUSTOM_FEE_1_ADVERTISER_CURRENCY",
- "METRIC_CUSTOM_FEE_2_ADVERTISER_CURRENCY",
- "METRIC_CUSTOM_FEE_3_ADVERTISER_CURRENCY",
- "METRIC_CUSTOM_FEE_4_ADVERTISER_CURRENCY",
- "METRIC_CUSTOM_FEE_5_ADVERTISER_CURRENCY",
- "METRIC_CUSTOM_VALUE_PER_1000_IMPRESSIONS",
- "METRIC_ENGAGEMENTS",
- "METRIC_ESTIMATED_CPM_FOR_IMPRESSIONS_WITH_CUSTOM_VALUE_ADVERTISER_CURRENCY",
- "METRIC_ESTIMATED_TOTAL_COST_FOR_IMPRESSIONS_WITH_CUSTOM_VALUE_ADVERTISER_CURRENCY",
- "METRIC_EXITS",
- "METRIC_EXPANSIONS",
- "METRIC_FIRST_QUARTILE_AUDIO",
- "METRIC_GENERAL_INVALID_TRAFFIC_GIVT_IMPRESSIONS",
- "METRIC_GENERAL_INVALID_TRAFFIC_GIVT_TRACKED_ADS",
- "METRIC_GIVT_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
- "METRIC_GIVT_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
- "METRIC_GIVT_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
- "METRIC_GIVT_BEGIN_TO_RENDER_IMPRESSIONS",
- "METRIC_GIVT_CLICKS",
- "METRIC_GMAIL_CONVERSIONS",
- "METRIC_GMAIL_POST_CLICK_CONVERSIONS",
- "METRIC_GMAIL_POST_VIEW_CONVERSIONS",
- "METRIC_GMAIL_POTENTIAL_VIEWS",
- "METRIC_IMPRESSIONS_WITH_CUSTOM_VALUE",
- "METRIC_IMPRESSIONS_WITH_POSITIVE_CUSTOM_VALUE",
- "METRIC_IMPRESSION_CUSTOM_VALUE_COST",
- "METRIC_INTERACTIVE_IMPRESSIONS",
- "METRIC_INVALID_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
- "METRIC_INVALID_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
- "METRIC_INVALID_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
- "METRIC_INVALID_BEGIN_TO_RENDER_IMPRESSIONS",
- "METRIC_INVALID_CLICKS",
- "METRIC_INVALID_IMPRESSIONS",
- "METRIC_INVALID_TRACKED_ADS",
- "METRIC_MEDIA_COST_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
- "METRIC_MIDPOINT_AUDIO",
- "METRIC_ORIGINAL_AUDIENCE_FREQUENCY",
- "METRIC_PAUSES_AUDIO",
- "METRIC_PERCENT_IMPRESSIONS_WITH_POSITIVE_CUSTOM_VALUE",
- "METRIC_PLATFORM_FEE_RATE",
- "METRIC_POST_CLICK_CONVERSIONS_CROSS_ENVIRONMENT",
- "METRIC_POST_VIEW_CONVERSIONS_CROSS_ENVIRONMENT",
- "METRIC_POTENTIAL_IMPRESSIONS",
- "METRIC_POTENTIAL_VIEWS",
- "METRIC_PREMIUM_FEE_ADVERTISER_CURRENCY",
- "METRIC_PROGRAMMATIC_GUARANTEED_IMPRESSIONS_PASSED_DUE_TO_FREQUENCY",
- "METRIC_PROGRAMMATIC_GUARANTEED_SAVINGS_RE_INVESTED_DUE_TO_FREQUENCY_ADVERTISER_CURRENCY",
- "METRIC_REFUND_BILLABLE_COST_ADVERTISER_CURRENCY",
- "METRIC_REFUND_MEDIA_COST_ADVERTISER_CURRENCY",
- "METRIC_REFUND_PLATFORM_FEE_ADVERTISER_CURRENCY",
- "METRIC_REVENUE_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
- "METRIC_RICH_MEDIA_ENGAGEMENTS",
- "METRIC_STARTS_AUDIO",
- "METRIC_STOPS_AUDIO",
- "METRIC_STORE_VISITS_ADX_ONLY",
- "METRIC_STORE_VISIT_CONVERSIONS",
- "METRIC_THIRD_QUARTILE_AUDIO",
- "METRIC_TIMERS",
- "METRIC_TOTAL_AUDIO_MEDIA_COST_ECPCL_ADVERTISER_CURRENCY",
- "METRIC_TOTAL_CONVERSIONS_CROSS_ENVIRONMENT",
- "METRIC_TOTAL_DISPLAY_TIME",
- "METRIC_TOTAL_IMPRESSION_CUSTOM_VALUE",
- "METRIC_TOTAL_INTERACTION_TIME",
- "METRIC_TOTAL_MEDIA_COST_ADVERTISER_CURRENCY_PER_STORE_VISIT_ADX_ONLY",
- "METRIC_TOTAL_USERS",
- "METRIC_TRACKED_ADS",
- "METRIC_TRUEVIEW_GENERAL_INVALID_TRAFFIC_GIVT_VIEWS",
- "METRIC_TRUEVIEW_INVALID_VIEWS",
- "METRIC_UNIQUE_COOKIES_WITH_IMPRESSIONS",
- "METRIC_UNIQUE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
- "METRIC_UNIQUE_REACH_CLICK_REACH",
- "METRIC_UNIQUE_REACH_IMPRESSION_REACH",
- "METRIC_UNIQUE_REACH_TOTAL_REACH",
- "METRIC_VERIFIABLE_IMPRESSIONS",
- "METRIC_VIDEO_CLIENT_COST_ECPCV_ADVERTISER_CURRENCY",
- "METRIC_WATCH_TIME",
- "METRIC_LAST_TOUCH_TOTAL_CONVERSIONS",
- "METRIC_LAST_TOUCH_CLICK_THROUGH_CONVERSIONS",
- "METRIC_LAST_TOUCH_VIEW_THROUGH_CONVERSIONS",
- "METRIC_TOTAL_PATHS",
- "METRIC_TOTAL_EXPOSURES",
- "METRIC_PATH_CONVERSION_RATE",
- "METRIC_CONVERTING_PATHS",
- "METRIC_ACTIVITY_REVENUE",
- "METRIC_PERCENT_INVALID_IMPRESSIONS_PREBID",
- "METRIC_GRP_CORRECTED_IMPRESSIONS",
- "METRIC_DEMO_CORRECTED_CLICKS",
- "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_BY_DEMO",
- "METRIC_VIRTUAL_PEOPLE_CLICK_REACH_BY_DEMO",
- "METRIC_VIRTUAL_PEOPLE_AVERAGE_IMPRESSION_FREQUENCY_BY_DEMO",
- "METRIC_DEMO_COMPOSITION_IMPRESSION",
- "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_SHARE_PERCENT",
- "METRIC_DEMO_POPULATION",
- "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_PERCENT",
- "METRIC_TARGET_RATING_POINTS",
- "METRIC_PROVISIONAL_IMPRESSIONS",
- "METRIC_VENDOR_BLOCKED_ADS",
- "METRIC_GRP_CORRECTED_VIEWABLE_IMPRESSIONS",
- "METRIC_GRP_CORRECTED_VIEWABLE_IMPRESSIONS_SHARE_PERCENT",
- "METRIC_VIEWABLE_GROSS_RATING_POINTS",
- "METRIC_VIRTUAL_PEOPLE_AVERAGE_VIEWABLE_IMPRESSION_FREQUENCY_BY_DEMO",
- "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_BY_DEMO",
- "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_PERCENT",
- "METRIC_VIRTUAL_PEOPLE_VIEWABLE_IMPRESSION_REACH_SHARE_PERCENT",
- "METRIC_ENGAGEMENT_RATE",
- "METRIC_CM360_POST_VIEW_REVENUE",
- "METRIC_CM360_POST_CLICK_REVENUE",
- "METRIC_CM360_POST_CLICK_REVENUE_CROSS_ENVIRONMENT",
- "METRIC_CM360_POST_VIEW_REVENUE_CROSS_ENVIRONMENT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "type": "array"
- },
- "options": {
- "$ref": "Options",
- "description": "Additional query options."
- },
- "type": {
- "description": "Report type.",
- "enum": [
- "TYPE_GENERAL",
- "TYPE_AUDIENCE_PERFORMANCE",
- "TYPE_INVENTORY_AVAILABILITY",
- "TYPE_KEYWORD",
- "TYPE_PIXEL_LOAD",
- "TYPE_AUDIENCE_COMPOSITION",
- "TYPE_CROSS_PARTNER",
- "TYPE_PAGE_CATEGORY",
- "TYPE_THIRD_PARTY_DATA_PROVIDER",
- "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER",
- "TYPE_CLIENT_SAFE",
- "TYPE_ORDER_ID",
- "TYPE_FEE",
- "TYPE_CROSS_FEE",
- "TYPE_ACTIVE_GRP",
- "TYPE_YOUTUBE_VERTICAL",
- "TYPE_COMSCORE_VCE",
- "TYPE_TRUEVIEW",
- "TYPE_NIELSEN_AUDIENCE_PROFILE",
- "TYPE_NIELSEN_DAILY_REACH_BUILD",
- "TYPE_NIELSEN_SITE",
- "TYPE_REACH_AND_FREQUENCY",
- "TYPE_ESTIMATED_CONVERSION",
- "TYPE_VERIFICATION",
- "TYPE_TRUEVIEW_IAR",
- "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET",
- "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE",
- "TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD",
- "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET",
- "TYPE_NOT_SUPPORTED",
- "TYPE_REACH_AUDIENCE",
- "TYPE_LINEAR_TV_SEARCH_LIFT",
- "TYPE_PATH",
- "TYPE_PATH_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "running": {
+ "description": "Whether the latest report is currently running.",
+ "type": "boolean"
},
- "PathFilter": {
- "description": "Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.",
- "id": "PathFilter",
- "properties": {
- "eventFilters": {
- "description": "Filter on an event to be applied to some part of the path.",
- "items": {
- "$ref": "EventFilter"
- },
- "type": "array"
- },
- "pathMatchPosition": {
- "description": "Indicates the position of the path the filter should match to (first, last, or any event in path).",
- "enum": [
- "ANY",
- "FIRST",
- "LAST"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "sendNotification": {
+ "description": "Whether to send an email notification when a report is ready. Default to false.",
+ "type": "boolean"
},
- "PathQueryOptions": {
- "description": "Path Query Options for Report Options.",
- "id": "PathQueryOptions",
- "properties": {
- "channelGrouping": {
- "$ref": "ChannelGrouping",
- "description": "Custom Channel Groupings."
- },
- "pathFilters": {
- "description": "Path Filters. There is a limit of 100 path filters that can be set per report.",
- "items": {
- "$ref": "PathFilter"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "shareEmailAddress": {
+ "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "PathQueryOptionsFilter": {
- "description": "Dimension Filter on path events.",
- "id": "PathQueryOptionsFilter",
- "properties": {
- "filter": {
- "description": "Dimension the filter is applied to.",
- "enum": [
- "FILTER_UNKNOWN",
- "FILTER_DATE",
- "FILTER_DAY_OF_WEEK",
- "FILTER_WEEK",
- "FILTER_MONTH",
- "FILTER_YEAR",
- "FILTER_TIME_OF_DAY",
- "FILTER_CONVERSION_DELAY",
- "FILTER_CREATIVE_ID",
- "FILTER_CREATIVE_SIZE",
- "FILTER_CREATIVE_TYPE",
- "FILTER_EXCHANGE_ID",
- "FILTER_AD_POSITION",
- "FILTER_PUBLIC_INVENTORY",
- "FILTER_INVENTORY_SOURCE",
- "FILTER_CITY",
- "FILTER_REGION",
- "FILTER_DMA",
- "FILTER_COUNTRY",
- "FILTER_SITE_ID",
- "FILTER_CHANNEL_ID",
- "FILTER_PARTNER",
- "FILTER_ADVERTISER",
- "FILTER_INSERTION_ORDER",
- "FILTER_LINE_ITEM",
- "FILTER_PARTNER_CURRENCY",
- "FILTER_ADVERTISER_CURRENCY",
- "FILTER_ADVERTISER_TIMEZONE",
- "FILTER_LINE_ITEM_TYPE",
- "FILTER_USER_LIST",
- "FILTER_USER_LIST_FIRST_PARTY",
- "FILTER_USER_LIST_THIRD_PARTY",
- "FILTER_TARGETED_USER_LIST",
- "FILTER_DATA_PROVIDER",
- "FILTER_ORDER_ID",
- "FILTER_VIDEO_PLAYER_SIZE",
- "FILTER_VIDEO_DURATION_SECONDS",
- "FILTER_KEYWORD",
- "FILTER_PAGE_CATEGORY",
- "FILTER_CAMPAIGN_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
- "FILTER_OS",
- "FILTER_BROWSER",
- "FILTER_CARRIER",
- "FILTER_SITE_LANGUAGE",
- "FILTER_INVENTORY_FORMAT",
- "FILTER_ZIP_CODE",
- "FILTER_VIDEO_RATING_TIER",
- "FILTER_VIDEO_FORMAT_SUPPORT",
- "FILTER_VIDEO_SKIPPABLE_SUPPORT",
- "FILTER_VIDEO_CREATIVE_DURATION",
- "FILTER_PAGE_LAYOUT",
- "FILTER_VIDEO_AD_POSITION_IN_STREAM",
- "FILTER_AGE",
- "FILTER_GENDER",
- "FILTER_QUARTER",
- "FILTER_TRUEVIEW_CONVERSION_TYPE",
- "FILTER_MOBILE_GEO",
- "FILTER_MRAID_SUPPORT",
- "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
- "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
- "FILTER_NIELSEN_COUNTRY_CODE",
- "FILTER_NIELSEN_DEVICE_ID",
- "FILTER_NIELSEN_GENDER",
- "FILTER_NIELSEN_AGE",
- "FILTER_INVENTORY_SOURCE_TYPE",
- "FILTER_CREATIVE_WIDTH",
- "FILTER_CREATIVE_HEIGHT",
- "FILTER_DFP_ORDER_ID",
- "FILTER_TRUEVIEW_AGE",
- "FILTER_TRUEVIEW_GENDER",
- "FILTER_TRUEVIEW_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_REMARKETING_LIST",
- "FILTER_TRUEVIEW_INTEREST",
- "FILTER_TRUEVIEW_AD_GROUP_ID",
- "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
- "FILTER_TRUEVIEW_IAR_LANGUAGE",
- "FILTER_TRUEVIEW_IAR_GENDER",
- "FILTER_TRUEVIEW_IAR_AGE",
- "FILTER_TRUEVIEW_IAR_CATEGORY",
- "FILTER_TRUEVIEW_IAR_COUNTRY",
- "FILTER_TRUEVIEW_IAR_CITY",
- "FILTER_TRUEVIEW_IAR_REGION",
- "FILTER_TRUEVIEW_IAR_ZIPCODE",
- "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
- "FILTER_TRUEVIEW_IAR_INTEREST",
- "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
- "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
- "FILTER_TRUEVIEW_CATEGORY",
- "FILTER_TRUEVIEW_KEYWORD",
- "FILTER_TRUEVIEW_PLACEMENT",
- "FILTER_TRUEVIEW_URL",
- "FILTER_TRUEVIEW_COUNTRY",
- "FILTER_TRUEVIEW_REGION",
- "FILTER_TRUEVIEW_CITY",
- "FILTER_TRUEVIEW_DMA",
- "FILTER_TRUEVIEW_ZIPCODE",
- "FILTER_NOT_SUPPORTED",
- "FILTER_MEDIA_PLAN",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
- "FILTER_SKIPPABLE_SUPPORT",
- "FILTER_COMPANION_CREATIVE_ID",
- "FILTER_BUDGET_SEGMENT_DESCRIPTION",
- "FILTER_FLOODLIGHT_ACTIVITY_ID",
- "FILTER_DEVICE_MODEL",
- "FILTER_DEVICE_MAKE",
- "FILTER_DEVICE_TYPE",
- "FILTER_CREATIVE_ATTRIBUTE",
- "FILTER_INVENTORY_COMMITMENT_TYPE",
- "FILTER_INVENTORY_RATE_TYPE",
- "FILTER_INVENTORY_DELIVERY_METHOD",
- "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
- "FILTER_AUTHORIZED_SELLER_STATE",
- "FILTER_VIDEO_DURATION_SECONDS_RANGE",
- "FILTER_PARTNER_NAME",
- "FILTER_PARTNER_STATUS",
- "FILTER_ADVERTISER_NAME",
- "FILTER_ADVERTISER_INTEGRATION_CODE",
- "FILTER_ADVERTISER_INTEGRATION_STATUS",
- "FILTER_CARRIER_NAME",
- "FILTER_CHANNEL_NAME",
- "FILTER_CITY_NAME",
- "FILTER_COMPANION_CREATIVE_NAME",
- "FILTER_USER_LIST_FIRST_PARTY_NAME",
- "FILTER_USER_LIST_THIRD_PARTY_NAME",
- "FILTER_NIELSEN_RESTATEMENT_DATE",
- "FILTER_NIELSEN_DATE_RANGE",
- "FILTER_INSERTION_ORDER_NAME",
- "FILTER_REGION_NAME",
- "FILTER_DMA_NAME",
- "FILTER_TRUEVIEW_IAR_REGION_NAME",
- "FILTER_TRUEVIEW_DMA_NAME",
- "FILTER_TRUEVIEW_REGION_NAME",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID",
- "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME",
- "FILTER_AD_TYPE",
- "FILTER_ALGORITHM",
- "FILTER_ALGORITHM_ID",
- "FILTER_AMP_PAGE_REQUEST",
- "FILTER_ANONYMOUS_INVENTORY_MODELING",
- "FILTER_APP_URL",
- "FILTER_APP_URL_EXCLUDED",
- "FILTER_ATTRIBUTED_USERLIST",
- "FILTER_ATTRIBUTED_USERLIST_COST",
- "FILTER_ATTRIBUTED_USERLIST_TYPE",
- "FILTER_ATTRIBUTION_MODEL",
- "FILTER_AUDIENCE_LIST",
- "FILTER_AUDIENCE_LIST_COST",
- "FILTER_AUDIENCE_LIST_TYPE",
- "FILTER_AUDIENCE_NAME",
- "FILTER_AUDIENCE_TYPE",
- "FILTER_BILLABLE_OUTCOME",
- "FILTER_BRAND_LIFT_TYPE",
- "FILTER_CHANNEL_TYPE",
- "FILTER_CM_PLACEMENT_ID",
- "FILTER_CONVERSION_SOURCE",
- "FILTER_CONVERSION_SOURCE_ID",
- "FILTER_COUNTRY_ID",
- "FILTER_CREATIVE",
- "FILTER_CREATIVE_ASSET",
- "FILTER_CREATIVE_INTEGRATION_CODE",
- "FILTER_CREATIVE_RENDERED_IN_AMP",
- "FILTER_CREATIVE_SOURCE",
- "FILTER_CREATIVE_STATUS",
- "FILTER_DATA_PROVIDER_NAME",
- "FILTER_DETAILED_DEMOGRAPHICS",
- "FILTER_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_DEVICE",
- "FILTER_GAM_INSERTION_ORDER",
- "FILTER_GAM_LINE_ITEM",
- "FILTER_GAM_LINE_ITEM_ID",
- "FILTER_DIGITAL_CONTENT_LABEL",
- "FILTER_DOMAIN",
- "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST",
- "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST",
- "FILTER_EXCHANGE",
- "FILTER_EXCHANGE_CODE",
- "FILTER_EXTENSION",
- "FILTER_EXTENSION_STATUS",
- "FILTER_EXTENSION_TYPE",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST",
- "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_FLOODLIGHT_ACTIVITY",
- "FILTER_FORMAT",
- "FILTER_GMAIL_AGE",
- "FILTER_GMAIL_CITY",
- "FILTER_GMAIL_COUNTRY",
- "FILTER_GMAIL_COUNTRY_NAME",
- "FILTER_GMAIL_DEVICE_TYPE",
- "FILTER_GMAIL_DEVICE_TYPE_NAME",
- "FILTER_GMAIL_GENDER",
- "FILTER_GMAIL_REGION",
- "FILTER_GMAIL_REMARKETING_LIST",
- "FILTER_HOUSEHOLD_INCOME",
- "FILTER_IMPRESSION_COUNTING_METHOD",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER",
- "FILTER_INSERTION_ORDER_INTEGRATION_CODE",
- "FILTER_INSERTION_ORDER_STATUS",
- "FILTER_INTEREST",
- "FILTER_INVENTORY_SOURCE_GROUP",
- "FILTER_INVENTORY_SOURCE_GROUP_ID",
- "FILTER_INVENTORY_SOURCE_ID",
- "FILTER_INVENTORY_SOURCE_NAME",
- "FILTER_LIFE_EVENT",
- "FILTER_LIFE_EVENTS",
- "FILTER_LINE_ITEM_INTEGRATION_CODE",
- "FILTER_LINE_ITEM_NAME",
- "FILTER_LINE_ITEM_STATUS",
- "FILTER_MATCH_RATIO",
- "FILTER_MEASUREMENT_SOURCE",
- "FILTER_MEDIA_PLAN_NAME",
- "FILTER_PARENTAL_STATUS",
- "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS",
- "FILTER_PLATFORM",
- "FILTER_PLAYBACK_METHOD",
- "FILTER_POSITION_IN_CONTENT",
- "FILTER_PUBLISHER_PROPERTY",
- "FILTER_PUBLISHER_PROPERTY_ID",
- "FILTER_PUBLISHER_PROPERTY_SECTION",
- "FILTER_PUBLISHER_PROPERTY_SECTION_ID",
- "FILTER_REFUND_REASON",
- "FILTER_REMARKETING_LIST",
- "FILTER_REWARDED",
- "FILTER_SENSITIVE_CATEGORY",
- "FILTER_SERVED_PIXEL_DENSITY",
- "FILTER_TARGETED_DATA_PROVIDERS",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST",
- "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE",
- "FILTER_TRUEVIEW_AD",
- "FILTER_TRUEVIEW_AD_GROUP",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS",
- "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID",
- "FILTER_TRUEVIEW_HOUSEHOLD_INCOME",
- "FILTER_TRUEVIEW_IAR_COUNTRY_NAME",
- "FILTER_TRUEVIEW_REMARKETING_LIST_NAME",
- "FILTER_VARIANT_ID",
- "FILTER_VARIANT_NAME",
- "FILTER_VARIANT_VERSION",
- "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE",
- "FILTER_VERIFICATION_VIDEO_POSITION",
- "FILTER_VIDEO_COMPANION_CREATIVE_SIZE",
- "FILTER_VIDEO_CONTINUOUS_PLAY",
- "FILTER_VIDEO_DURATION",
- "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST",
- "FILTER_YOUTUBE_AD_VIDEO",
- "FILTER_YOUTUBE_AD_VIDEO_ID",
- "FILTER_YOUTUBE_CHANNEL",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER",
- "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER",
- "FILTER_YOUTUBE_VIDEO",
- "FILTER_ZIP_POSTAL_CODE",
- "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS",
- "FILTER_TRUEVIEW_PLACEMENT_ID",
- "FILTER_PATH_PATTERN_ID",
- "FILTER_PATH_EVENT_INDEX",
- "FILTER_EVENT_TYPE",
- "FILTER_CHANNEL_GROUPING",
- "FILTER_OM_SDK_AVAILABLE",
- "FILTER_DATA_SOURCE",
- "FILTER_CM360_PLACEMENT_ID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "match": {
- "description": "Indicates how the filter should be matched to the value.",
- "enum": [
- "UNKNOWN",
- "EXACT",
- "PARTIAL",
- "BEGINS_WITH",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "values": {
- "description": "Value to filter on.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "title": {
+ "description": "Query title. It is used to name the reports generated from this query.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QuerySchedule": {
+ "description": "Information on how frequently and when to run a query.",
+ "id": "QuerySchedule",
+ "properties": {
+ "endTimeMs": {
+ "description": "Datetime to periodically run the query until.",
+ "format": "int64",
+ "type": "string"
},
- "Query": {
- "description": "Represents a query.",
- "id": "Query",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\".",
- "type": "string"
- },
- "metadata": {
- "$ref": "QueryMetadata",
- "description": "Query metadata."
- },
- "params": {
- "$ref": "Parameters",
- "description": "Query parameters."
- },
- "queryId": {
- "description": "Query ID.",
- "format": "int64",
- "type": "string"
- },
- "reportDataEndTimeMs": {
- "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
- "format": "int64",
- "type": "string"
- },
- "reportDataStartTimeMs": {
- "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
- "format": "int64",
- "type": "string"
- },
- "schedule": {
- "$ref": "QuerySchedule",
- "description": "Information on how often and when to run a query."
- },
- "timezoneCode": {
- "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
- "type": "string"
- }
- },
- "type": "object"
+ "frequency": {
+ "description": "How often the query is run.",
+ "enum": [
+ "ONE_TIME",
+ "DAILY",
+ "WEEKLY",
+ "SEMI_MONTHLY",
+ "MONTHLY",
+ "QUARTERLY",
+ "YEARLY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "QueryMetadata": {
- "description": "Query metadata.",
- "id": "QueryMetadata",
- "properties": {
- "dataRange": {
- "description": "Range of report data.",
- "enum": [
- "CUSTOM_DATES",
- "CURRENT_DAY",
- "PREVIOUS_DAY",
- "WEEK_TO_DATE",
- "MONTH_TO_DATE",
- "QUARTER_TO_DATE",
- "YEAR_TO_DATE",
- "PREVIOUS_WEEK",
- "PREVIOUS_HALF_MONTH",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_YEAR",
- "LAST_7_DAYS",
- "LAST_30_DAYS",
- "LAST_90_DAYS",
- "LAST_365_DAYS",
- "ALL_TIME",
- "LAST_14_DAYS",
- "TYPE_NOT_SUPPORTED",
- "LAST_60_DAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "format": {
- "description": "Format of the generated report.",
- "enum": [
- "CSV",
- "EXCEL_CSV",
- "XLSX"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "googleCloudStoragePathForLatestReport": {
- "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
- "type": "string"
- },
- "googleDrivePathForLatestReport": {
- "description": "The path in Google Drive for the latest report.",
- "type": "string"
- },
- "latestReportRunTimeMs": {
- "description": "The time when the latest report started to run.",
- "format": "int64",
- "type": "string"
- },
- "locale": {
- "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.",
- "type": "string"
- },
- "reportCount": {
- "description": "Number of reports that have been generated for the query.",
- "format": "int32",
- "type": "integer"
- },
- "running": {
- "description": "Whether the latest report is currently running.",
- "type": "boolean"
- },
- "sendNotification": {
- "description": "Whether to send an email notification when a report is ready. Default to false.",
- "type": "boolean"
- },
- "shareEmailAddress": {
- "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "title": {
- "description": "Query title. It is used to name the reports generated from this query.",
- "type": "string"
- }
- },
- "type": "object"
+ "nextRunMinuteOfDay": {
+ "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.",
+ "format": "int32",
+ "type": "integer"
},
- "QuerySchedule": {
- "description": "Information on how frequently and when to run a query.",
- "id": "QuerySchedule",
- "properties": {
- "endTimeMs": {
- "description": "Datetime to periodically run the query until.",
- "format": "int64",
- "type": "string"
- },
- "frequency": {
- "description": "How often the query is run.",
- "enum": [
- "ONE_TIME",
- "DAILY",
- "WEEKLY",
- "SEMI_MONTHLY",
- "MONTHLY",
- "QUARTERLY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "nextRunMinuteOfDay": {
- "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.",
- "format": "int32",
- "type": "integer"
- },
- "nextRunTimezoneCode": {
- "description": "Canonical timezone code for report generation time. Defaults to America/New_York.",
- "type": "string"
- },
- "startTimeMs": {
- "description": "When to start running the query. Not applicable to `ONE_TIME` frequency.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "nextRunTimezoneCode": {
+ "description": "Canonical timezone code for report generation time. Defaults to America/New_York.",
+ "type": "string"
},
- "Report": {
- "description": "Represents a report.",
- "id": "Report",
- "properties": {
- "key": {
- "$ref": "ReportKey",
- "description": "Key used to identify a report."
- },
- "metadata": {
- "$ref": "ReportMetadata",
- "description": "Report metadata."
- },
- "params": {
- "$ref": "Parameters",
- "description": "Report parameters."
- }
- },
- "type": "object"
+ "startTimeMs": {
+ "description": "When to start running the query. Not applicable to `ONE_TIME` frequency.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "Represents a report.",
+ "id": "Report",
+ "properties": {
+ "key": {
+ "$ref": "ReportKey",
+ "description": "Key used to identify a report."
},
- "ReportFailure": {
- "description": "An explanation of a report failure.",
- "id": "ReportFailure",
- "properties": {
- "errorCode": {
- "description": "Error code that shows why the report was not created.",
- "enum": [
- "AUTHENTICATION_ERROR",
- "UNAUTHORIZED_API_ACCESS",
- "SERVER_ERROR",
- "VALIDATION_ERROR",
- "REPORTING_FATAL_ERROR",
- "REPORTING_TRANSIENT_ERROR",
- "REPORTING_IMCOMPATIBLE_METRICS",
- "REPORTING_ILLEGAL_FILENAME",
- "REPORTING_QUERY_NOT_FOUND",
- "REPORTING_BUCKET_NOT_FOUND",
- "REPORTING_CREATE_BUCKET_FAILED",
- "REPORTING_DELETE_BUCKET_FAILED",
- "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
- "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
- "DEPRECATED_REPORTING_INVALID_QUERY",
- "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
- "REPORTING_INVALID_QUERY_TITLE_MISSING",
- "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "metadata": {
+ "$ref": "ReportMetadata",
+ "description": "Report metadata."
},
- "ReportKey": {
- "description": "Key used to identify a report.",
- "id": "ReportKey",
- "properties": {
- "queryId": {
- "description": "Query ID.",
- "format": "int64",
- "type": "string"
- },
- "reportId": {
- "description": "Report ID.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
+ "params": {
+ "$ref": "Parameters",
+ "description": "Report parameters."
+ }
+ },
+ "type": "object"
+ },
+ "ReportFailure": {
+ "description": "An explanation of a report failure.",
+ "id": "ReportFailure",
+ "properties": {
+ "errorCode": {
+ "description": "Error code that shows why the report was not created.",
+ "enum": [
+ "AUTHENTICATION_ERROR",
+ "UNAUTHORIZED_API_ACCESS",
+ "SERVER_ERROR",
+ "VALIDATION_ERROR",
+ "REPORTING_FATAL_ERROR",
+ "REPORTING_TRANSIENT_ERROR",
+ "REPORTING_IMCOMPATIBLE_METRICS",
+ "REPORTING_ILLEGAL_FILENAME",
+ "REPORTING_QUERY_NOT_FOUND",
+ "REPORTING_BUCKET_NOT_FOUND",
+ "REPORTING_CREATE_BUCKET_FAILED",
+ "REPORTING_DELETE_BUCKET_FAILED",
+ "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
+ "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
+ "DEPRECATED_REPORTING_INVALID_QUERY",
+ "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
+ "REPORTING_INVALID_QUERY_TITLE_MISSING",
+ "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportKey": {
+ "description": "Key used to identify a report.",
+ "id": "ReportKey",
+ "properties": {
+ "queryId": {
+ "description": "Query ID.",
+ "format": "int64",
+ "type": "string"
},
- "ReportMetadata": {
- "description": "Report metadata.",
- "id": "ReportMetadata",
- "properties": {
- "googleCloudStoragePath": {
- "description": "The path to the location in Google Cloud Storage where the report is stored.",
- "type": "string"
- },
- "reportDataEndTimeMs": {
- "description": "The ending time for the data that is shown in the report.",
- "format": "int64",
- "type": "string"
- },
- "reportDataStartTimeMs": {
- "description": "The starting time for the data that is shown in the report.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "$ref": "ReportStatus",
- "description": "Report status."
- }
- },
- "type": "object"
+ "reportId": {
+ "description": "Report ID.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportMetadata": {
+ "description": "Report metadata.",
+ "id": "ReportMetadata",
+ "properties": {
+ "googleCloudStoragePath": {
+ "description": "The path to the location in Google Cloud Storage where the report is stored.",
+ "type": "string"
},
- "ReportStatus": {
- "description": "Report status.",
- "id": "ReportStatus",
- "properties": {
- "failure": {
- "$ref": "ReportFailure",
- "description": "If the report failed, this records the cause."
- },
- "finishTimeMs": {
- "description": "The time when this report either completed successfully or failed.",
- "format": "int64",
- "type": "string"
- },
- "format": {
- "description": "The file type of the report.",
- "enum": [
- "CSV",
- "EXCEL_CSV",
- "XLSX"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "state": {
- "description": "The state of the report.",
- "enum": [
- "RUNNING",
- "DONE",
- "FAILED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report.",
+ "format": "int64",
+ "type": "string"
},
- "RowStatus": {
- "description": "Represents the upload status of a row in the request.",
- "id": "RowStatus",
- "properties": {
- "changed": {
- "description": "Whether the stored entity is changed as a result of upload.",
- "type": "boolean"
- },
- "entityId": {
- "description": "Entity Id.",
- "format": "int64",
- "type": "string"
- },
- "entityName": {
- "description": "Entity name.",
- "type": "string"
- },
- "errors": {
- "description": "Reasons why the entity can't be uploaded.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "persisted": {
- "description": "Whether the entity is persisted.",
- "type": "boolean"
- },
- "rowNumber": {
- "description": "Row number.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report.",
+ "format": "int64",
+ "type": "string"
},
- "Rule": {
- "description": "A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.",
- "id": "Rule",
- "properties": {
- "disjunctiveMatchStatements": {
- "items": {
- "$ref": "DisjunctiveMatchStatement"
- },
- "type": "array"
- },
- "name": {
- "description": "Rule name.",
- "type": "string"
- }
- },
- "type": "object"
+ "status": {
+ "$ref": "ReportStatus",
+ "description": "Report status."
+ }
+ },
+ "type": "object"
+ },
+ "ReportStatus": {
+ "description": "Report status.",
+ "id": "ReportStatus",
+ "properties": {
+ "failure": {
+ "$ref": "ReportFailure",
+ "description": "If the report failed, this records the cause."
},
- "RunQueryRequest": {
- "description": "Request to run a stored query to generate a report.",
- "id": "RunQueryRequest",
- "properties": {
- "dataRange": {
- "description": "Report data range used to generate the report.",
- "enum": [
- "CUSTOM_DATES",
- "CURRENT_DAY",
- "PREVIOUS_DAY",
- "WEEK_TO_DATE",
- "MONTH_TO_DATE",
- "QUARTER_TO_DATE",
- "YEAR_TO_DATE",
- "PREVIOUS_WEEK",
- "PREVIOUS_HALF_MONTH",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_YEAR",
- "LAST_7_DAYS",
- "LAST_30_DAYS",
- "LAST_90_DAYS",
- "LAST_365_DAYS",
- "ALL_TIME",
- "LAST_14_DAYS",
- "TYPE_NOT_SUPPORTED",
- "LAST_60_DAYS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "reportDataEndTimeMs": {
- "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
- "format": "int64",
- "type": "string"
- },
- "reportDataStartTimeMs": {
- "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
- "format": "int64",
- "type": "string"
- },
- "timezoneCode": {
- "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
- "type": "string"
- }
- },
- "type": "object"
+ "finishTimeMs": {
+ "description": "The time when this report either completed successfully or failed.",
+ "format": "int64",
+ "type": "string"
},
- "UploadLineItemsRequest": {
- "description": "Request to upload line items.",
- "id": "UploadLineItemsRequest",
- "properties": {
- "dryRun": {
- "description": "Set to true to get upload status without actually persisting the line items.",
- "type": "boolean"
- },
- "format": {
- "description": "Format the line items are in. Default to CSV.",
- "enum": [
- "CSV"
- ],
- "enumDescriptions": [
- ""
- ],
- "type": "string"
- },
- "lineItems": {
- "description": "Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.",
- "type": "string"
- }
- },
- "type": "object"
+ "format": {
+ "description": "The file type of the report.",
+ "enum": [
+ "CSV",
+ "EXCEL_CSV",
+ "XLSX"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "UploadLineItemsResponse": {
- "description": "Upload line items response.",
- "id": "UploadLineItemsResponse",
- "properties": {
- "uploadStatus": {
- "$ref": "UploadStatus",
- "description": "Status of upload."
- }
- },
- "type": "object"
+ "state": {
+ "description": "The state of the report.",
+ "enum": [
+ "RUNNING",
+ "DONE",
+ "FAILED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Rule": {
+ "description": "A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.",
+ "id": "Rule",
+ "properties": {
+ "disjunctiveMatchStatements": {
+ "items": {
+ "$ref": "DisjunctiveMatchStatement"
+ },
+ "type": "array"
},
- "UploadStatus": {
- "description": "Represents the status of upload.",
- "id": "UploadStatus",
- "properties": {
- "errors": {
- "description": "Reasons why upload can't be completed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "rowStatus": {
- "description": "Per-row upload status.",
- "items": {
- "$ref": "RowStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
+ "name": {
+ "description": "Rule name.",
+ "type": "string"
}
+ },
+ "type": "object"
},
- "servicePath": "doubleclickbidmanager/v1.1/",
- "title": "DoubleClick Bid Manager API",
- "version": "v1.1"
+ "RunQueryRequest": {
+ "description": "Request to run a stored query to generate a report.",
+ "id": "RunQueryRequest",
+ "properties": {
+ "dataRange": {
+ "description": "Report data range used to generate the report.",
+ "enum": [
+ "CUSTOM_DATES",
+ "CURRENT_DAY",
+ "PREVIOUS_DAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_HALF_MONTH",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "ALL_TIME",
+ "LAST_14_DAYS",
+ "TYPE_NOT_SUPPORTED",
+ "LAST_60_DAYS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timezoneCode": {
+ "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "doubleclickbidmanager/v1.1/",
+ "title": "DoubleClick Bid Manager API",
+ "version": "v1.1"
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json
index c77cde4d4cc..ecc271fb247 100644
--- a/googleapiclient/discovery_cache/documents/drive.v2.json
+++ b/googleapiclient/discovery_cache/documents/drive.v2.json
@@ -38,7 +38,7 @@
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/drive/",
- "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/zennBzBE1meCOvZxW4ZeXv3FLco\"",
+ "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/tcvbPbfk4fm6YC9mzFoGufOyHLc\"",
"icons": {
"x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png",
"x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png"
@@ -3527,7 +3527,7 @@
}
}
},
- "revision": "20210516",
+ "revision": "20210524",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"About": {
@@ -5098,7 +5098,7 @@
"type": "array"
},
"owners": {
- "description": "The owner(s) of this file. Not populated for items in shared drives.",
+ "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.",
"items": {
"$ref": "User"
},
diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json
index 26ac7b02acc..ee731707b7e 100644
--- a/googleapiclient/discovery_cache/documents/drive.v3.json
+++ b/googleapiclient/discovery_cache/documents/drive.v3.json
@@ -35,7 +35,7 @@
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/drive/",
- "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/flD37epa4K_hC-bv7s4sOJoeJlI\"",
+ "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/KFxZC8gV5KZAPkrIpQvAsqAcIFE\"",
"icons": {
"x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png",
"x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png"
@@ -2191,7 +2191,7 @@
}
}
},
- "revision": "20210516",
+ "revision": "20210524",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"About": {
@@ -3192,7 +3192,7 @@
"type": "boolean"
},
"owners": {
- "description": "The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.",
+ "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.",
"items": {
"$ref": "User"
},
diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json
index 4055e0bda51..2aa4fbd1c5d 100644
--- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json
+++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json
@@ -132,7 +132,7 @@
}
}
},
- "revision": "20210522",
+ "revision": "20210526",
"rootUrl": "https://driveactivity.googleapis.com/",
"schemas": {
"Action": {
diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json
index e638dcf0c02..de66f0faf37 100644
--- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json
+++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json
@@ -850,7 +850,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://essentialcontacts.googleapis.com/",
"schemas": {
"GoogleCloudEssentialcontactsV1ComputeContactsResponse": {
diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
index c1ecc6a9f2d..9cef4bdd4d3 100644
--- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
@@ -1121,7 +1121,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://firebase.googleapis.com/",
"schemas": {
"AddFirebaseRequest": {
diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json
index 39f20a0c5a1..44277ee97c8 100644
--- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json
@@ -317,7 +317,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://firebasedatabase.googleapis.com/",
"schemas": {
"DatabaseInstance": {
diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json
index 545ff5b5841..439c65be810 100644
--- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json
+++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json
@@ -204,7 +204,7 @@
}
}
},
- "revision": "20210524",
+ "revision": "20210526",
"rootUrl": "https://firebaseml.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json
index 13ecad7485d..e50820d76c0 100644
--- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json
@@ -318,7 +318,7 @@
}
}
},
- "revision": "20210524",
+ "revision": "20210526",
"rootUrl": "https://firebaseml.googleapis.com/",
"schemas": {
"DownloadModelResponse": {
diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json
index dd7b6ae86f3..e069fe7927e 100644
--- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json
@@ -238,7 +238,7 @@
}
}
},
- "revision": "20210517",
+ "revision": "20210521",
"rootUrl": "https://firebasestorage.googleapis.com/",
"schemas": {
"AddFirebaseRequest": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json
index 8a832a1f5b0..283445a41f1 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1.json
@@ -1160,7 +1160,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210518",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"ArrayValue": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
index 0dcde08602e..bb651a27a1e 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
@@ -849,7 +849,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210518",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"ArrayValue": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
index e622a1e728e..f0b4a5d1536 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
@@ -415,7 +415,7 @@
}
}
},
- "revision": "20210426",
+ "revision": "20210518",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json
index 5462229f4ef..cc11cde9258 100644
--- a/googleapiclient/discovery_cache/documents/fitness.v1.json
+++ b/googleapiclient/discovery_cache/documents/fitness.v1.json
@@ -831,7 +831,7 @@
}
}
},
- "revision": "20210522",
+ "revision": "20210524",
"rootUrl": "https://fitness.googleapis.com/",
"schemas": {
"AggregateBucket": {
diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json
index 34e59522a5a..7bf4b73bad6 100644
--- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json
+++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json
@@ -265,7 +265,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://gmailpostmastertools.googleapis.com/",
"schemas": {
"DeliveryError": {
diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json
index d52cec92eb6..77f24e037d0 100644
--- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json
@@ -265,7 +265,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://gmailpostmastertools.googleapis.com/",
"schemas": {
"DeliveryError": {
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index 9c44145afbc..52d066cf4b3 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -1696,7 +1696,7 @@
}
}
},
- "revision": "20210519",
+ "revision": "20210520",
"rootUrl": "https://iam.googleapis.com/",
"schemas": {
"AdminAuditData": {
diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json
index 572af11225c..40326c40944 100644
--- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json
+++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json
@@ -279,7 +279,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://libraryagent.googleapis.com/",
"schemas": {
"GoogleExampleLibraryagentV1Book": {
diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json
index c498c869ccd..fd321ff32d0 100644
--- a/googleapiclient/discovery_cache/documents/localservices.v1.json
+++ b/googleapiclient/discovery_cache/documents/localservices.v1.json
@@ -250,7 +250,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://localservices.googleapis.com/",
"schemas": {
"GoogleAdsHomeservicesLocalservicesV1AccountReport": {
diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json
index 5f117e59edb..908a59f9dfe 100644
--- a/googleapiclient/discovery_cache/documents/logging.v2.json
+++ b/googleapiclient/discovery_cache/documents/logging.v2.json
@@ -2728,7 +2728,7 @@
],
"parameters": {
"name": {
- "description": "Required. The resource name for the CMEK settings to update. \"projects/[PROJECT_ID]/cmekSettings\" \"organizations/[ORGANIZATION_ID]/cmekSettings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings\" \"folders/[FOLDER_ID]/cmekSettings\" Example: \"organizations/12345/cmekSettings\".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.",
+ "description": "Required. The resource name for the CMEK settings to update. < \"projects/PROJECT_ID/cmekSettings\" \"organizations/ORGANIZATION_ID/cmekSettings\" \"billingAccounts/BILLING_ACCOUNT_ID/cmekSettings\" \"folders/FOLDER_ID/cmekSettings\"Example: \"organizations/12345/cmekSettings\".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
@@ -4906,7 +4906,7 @@
],
"parameters": {
"name": {
- "description": "Required. The resource name for the CMEK settings to update. \"projects/[PROJECT_ID]/cmekSettings\" \"organizations/[ORGANIZATION_ID]/cmekSettings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings\" \"folders/[FOLDER_ID]/cmekSettings\" Example: \"organizations/12345/cmekSettings\".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.",
+ "description": "Required. The resource name for the CMEK settings to update. < \"projects/PROJECT_ID/cmekSettings\" \"organizations/ORGANIZATION_ID/cmekSettings\" \"billingAccounts/BILLING_ACCOUNT_ID/cmekSettings\" \"folders/FOLDER_ID/cmekSettings\"Example: \"organizations/12345/cmekSettings\".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
@@ -4934,7 +4934,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210521",
"rootUrl": "https://logging.googleapis.com/",
"schemas": {
"BigQueryOptions": {
diff --git a/googleapiclient/discovery_cache/documents/ml.v1.json b/googleapiclient/discovery_cache/documents/ml.v1.json
index d494d8b36d2..03563374a67 100644
--- a/googleapiclient/discovery_cache/documents/ml.v1.json
+++ b/googleapiclient/discovery_cache/documents/ml.v1.json
@@ -1486,7 +1486,7 @@
}
}
},
- "revision": "20210429",
+ "revision": "20210520",
"rootUrl": "https://ml.googleapis.com/",
"schemas": {
"GoogleApi__HttpBody": {
diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json
index 8acbad1067f..9217fd1b3a0 100644
--- a/googleapiclient/discovery_cache/documents/monitoring.v1.json
+++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json
@@ -285,7 +285,7 @@
}
}
},
- "revision": "20210514",
+ "revision": "20210522",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json
index 746c27bda77..6da65db576b 100644
--- a/googleapiclient/discovery_cache/documents/monitoring.v3.json
+++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json
@@ -2541,7 +2541,7 @@
}
}
},
- "revision": "20210514",
+ "revision": "20210522",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json
index 4246dce6d72..b7f1c5de47c 100644
--- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json
+++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json
@@ -751,7 +751,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://orgpolicy.googleapis.com/",
"schemas": {
"GoogleCloudOrgpolicyV2Constraint": {
diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json
index 81d541c7749..92c8fa0485c 100644
--- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json
+++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json
@@ -193,7 +193,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://pagespeedonline.googleapis.com/",
"schemas": {
"AuditRefs": {
diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
index e21de069d65..d026294e0ba 100644
--- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
+++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
@@ -366,7 +366,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://paymentsresellersubscription.googleapis.com/",
"schemas": {
"GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest": {
diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json
index 184c2c0e36d..18f27a1b245 100644
--- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json
+++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json
@@ -158,7 +158,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://playcustomapp.googleapis.com/",
"schemas": {
"CustomApp": {
diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json
index 20ceb9a4dae..fcc611a6d82 100644
--- a/googleapiclient/discovery_cache/documents/pubsub.v1.json
+++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json
@@ -1424,7 +1424,7 @@
}
}
},
- "revision": "20210511",
+ "revision": "20210517",
"rootUrl": "https://pubsub.googleapis.com/",
"schemas": {
"AcknowledgeRequest": {
diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json
index 33e36676a22..983c3417e99 100644
--- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json
+++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json
@@ -457,7 +457,7 @@
}
}
},
- "revision": "20210511",
+ "revision": "20210517",
"rootUrl": "https://pubsub.googleapis.com/",
"schemas": {
"AcknowledgeRequest": {
diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json
index 0ead130b3a7..0632e7d2d98 100644
--- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json
@@ -724,7 +724,7 @@
}
}
},
- "revision": "20210511",
+ "revision": "20210517",
"rootUrl": "https://pubsub.googleapis.com/",
"schemas": {
"AcknowledgeRequest": {
diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
index a763b082b82..e7e42cc304f 100644
--- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
+++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
@@ -1140,7 +1140,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://realtimebidding.googleapis.com/",
"schemas": {
"ActivatePretargetingConfigRequest": {
diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json
index 2616442fed4..ae9637397fd 100644
--- a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json
@@ -178,7 +178,7 @@
}
}
},
- "revision": "20210526",
+ "revision": "20210527",
"rootUrl": "https://realtimebidding.googleapis.com/",
"schemas": {
"BiddingFunction": {
diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json
index a83f424265c..bf798410779 100644
--- a/googleapiclient/discovery_cache/documents/run.v1.json
+++ b/googleapiclient/discovery_cache/documents/run.v1.json
@@ -1736,7 +1736,7 @@
}
}
},
- "revision": "20210517",
+ "revision": "20210521",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"Addressable": {
diff --git a/googleapiclient/discovery_cache/documents/run.v1alpha1.json b/googleapiclient/discovery_cache/documents/run.v1alpha1.json
index cab5b823e0d..2372634a6a1 100644
--- a/googleapiclient/discovery_cache/documents/run.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/run.v1alpha1.json
@@ -268,7 +268,7 @@
}
}
},
- "revision": "20210517",
+ "revision": "20210521",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"Capabilities": {
diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json
index 5a805584e60..c061b2f7029 100644
--- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json
+++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json
@@ -261,7 +261,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://safebrowsing.googleapis.com/",
"schemas": {
"GoogleProtobufEmpty": {
diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json
index 833d233b0b6..18d6045afd4 100644
--- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json
+++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json
@@ -373,7 +373,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://searchconsole.googleapis.com/",
"schemas": {
"ApiDataRow": {
diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
index 9d834d9eb2a..a6a1c525a1a 100644
--- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
@@ -542,7 +542,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"AddTenantProjectRequest": {
diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
index 2fe26330215..d17ae0ddb6f 100644
--- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
@@ -500,7 +500,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"Api": {
diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json
index 70eb7b46c61..0dc7686a027 100644
--- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json
+++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json
@@ -197,7 +197,7 @@
}
}
},
- "revision": "20210508",
+ "revision": "20210513",
"rootUrl": "https://servicecontrol.googleapis.com/",
"schemas": {
"AllocateInfo": {
diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json
index 06b11eb2a55..1f60b00446c 100644
--- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json
+++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json
@@ -169,7 +169,7 @@
}
}
},
- "revision": "20210508",
+ "revision": "20210513",
"rootUrl": "https://servicecontrol.googleapis.com/",
"schemas": {
"Api": {
@@ -699,6 +699,14 @@
"description": "Describes a resource referenced in the request.",
"id": "ResourceInfo",
"properties": {
+ "container": {
+ "description": "Optional. The identifier of the container of this resource. For Google Cloud APIs, the resource container must be one of the following formats: - `projects/` - `folders/` - `organizations/` For the policy enforcement on the container level (VPCSC and Location Policy check), this field takes precedence on the container extracted from name when presents.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Optional. The location of the resource. The value must be a valid zone, region or multiregion. For example: \"europe-west4\" or \"northamerica-northeast1-a\"",
+ "type": "string"
+ },
"name": {
"description": "The name of the resource referenced in the request.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
index 96cf616c64f..fbcbf05e740 100644
--- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
+++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
@@ -883,7 +883,7 @@
}
}
},
- "revision": "20210512",
+ "revision": "20210521",
"rootUrl": "https://servicedirectory.googleapis.com/",
"schemas": {
"Binding": {
diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
index 1493f0e425f..338bf75113d 100644
--- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
@@ -883,7 +883,7 @@
}
}
},
- "revision": "20210512",
+ "revision": "20210521",
"rootUrl": "https://servicedirectory.googleapis.com/",
"schemas": {
"Binding": {
diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json
index f655c7337f6..3e0ce1529a6 100644
--- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json
+++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json
@@ -860,7 +860,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://servicenetworking.googleapis.com/",
"schemas": {
"AddDnsRecordSetMetadata": {
diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json
index 0819de4445d..6e549d22306 100644
--- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json
@@ -307,7 +307,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://servicenetworking.googleapis.com/",
"schemas": {
"AddDnsRecordSetMetadata": {
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json
index 6c7bd546853..2a753c842ad 100644
--- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json
+++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json
@@ -426,7 +426,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AdminQuotaPolicy": {
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
index 2f2325ea615..4983134960a 100644
--- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
@@ -959,7 +959,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AdminQuotaPolicy": {
diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json
index 9ccd13ccba6..dca21c2220e 100644
--- a/googleapiclient/discovery_cache/documents/speech.v1.json
+++ b/googleapiclient/discovery_cache/documents/speech.v1.json
@@ -212,7 +212,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210519",
"rootUrl": "https://speech.googleapis.com/",
"schemas": {
"ListOperationsResponse": {
diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json
index 329b49fba79..3a9c6d27ab2 100644
--- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json
+++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json
@@ -524,7 +524,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210519",
"rootUrl": "https://speech.googleapis.com/",
"schemas": {
"ClassItem": {
diff --git a/googleapiclient/discovery_cache/documents/speech.v2beta1.json b/googleapiclient/discovery_cache/documents/speech.v2beta1.json
index 279bf115fa6..45d1f4d9f16 100644
--- a/googleapiclient/discovery_cache/documents/speech.v2beta1.json
+++ b/googleapiclient/discovery_cache/documents/speech.v2beta1.json
@@ -184,7 +184,7 @@
}
}
},
- "revision": "20210513",
+ "revision": "20210519",
"rootUrl": "https://speech.googleapis.com/",
"schemas": {
"ListOperationsResponse": {
diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json
index 70143134ee2..1dcf6369a28 100644
--- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json
+++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json
@@ -375,7 +375,7 @@
}
}
},
- "revision": "20210525",
+ "revision": "20210526",
"rootUrl": "https://streetviewpublish.googleapis.com/",
"schemas": {
"BatchDeletePhotosRequest": {