Refresh docs
This commit is contained in:
Joe Gregorio
@@ -130,7 +130,7 @@ METHOD_LINK = """<p class="toc_element">
|
||||
|
||||
BASE = 'docs/dyn'
|
||||
|
||||
DIRECTORY_URI = 'https://www.googleapis.com/discovery/v1/apis?preferred=true',
|
||||
DIRECTORY_URI = 'https://www.googleapis.com/discovery/v1/apis?preferred=true'
|
||||
|
||||
FLAGS = gflags.FLAGS
|
||||
|
||||
|
||||
@@ -89,8 +89,10 @@ Args:
|
||||
productCode: string, Products to associate with the user. (required) (repeated)
|
||||
Allowed values
|
||||
AFC - AdSense For Content
|
||||
AFG - AdSense For Games
|
||||
AFMC - AdSense For Mobile Content
|
||||
AFS - AdSense For Search
|
||||
AFV - AdSense For Video
|
||||
websiteUrl: string, The URL of the user's hosted website. (required)
|
||||
websiteLocale: string, The locale of the user's hosted website.
|
||||
userLocale: string, The preferred locale of the user.
|
||||
|
||||
@@ -75,11 +75,11 @@ h1, h2, h3 {
|
||||
<h1><a href="audit_v1.html">Enterprise Audit API</a> . <a href="audit_v1.activities.html">activities</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</a></code></p>
|
||||
<code><a href="#list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of activities for a specific customer and application.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</code>
|
||||
<code class="details" id="list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)</code>
|
||||
<pre>Retrieves a list of activities for a specific customer and application.
|
||||
|
||||
Args:
|
||||
@@ -95,7 +95,6 @@ Args:
|
||||
actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
|
||||
continuationToken: string, Next page URL.
|
||||
maxResults: integer, Number of activity records to be shown in each page.
|
||||
parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...
|
||||
actorEmail: string, Email address of the user who performed the action.
|
||||
endTime: string, Return events which occured at or before this time.
|
||||
|
||||
|
||||
@@ -144,34 +144,34 @@ Returns:
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','. Note that delimiters are applied to the raw, binary data before the encoding is applied.
|
||||
"sourceFormat": "A String", # [Experimental] Optional and defaults to CSV. Format of source files. For CSV uploads, specify "CSV". For imports of datastore backups, specify "DATASTORE_BACKUP". For imports of newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
|
||||
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
|
||||
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
|
||||
"destinationTable": { # [Required] The destination table to load the data into.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
],
|
||||
"quote": "A String", # [Optional] Quote character to use. Default is '"'. Note that quoting is done on the raw, binary data before the encoding is applied. If no quoting is done, use am empty string.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
|
||||
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
|
||||
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
|
||||
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
|
||||
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -200,6 +200,7 @@ Returns:
|
||||
},
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
@@ -273,12 +274,12 @@ Returns:
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -334,34 +335,34 @@ Args:
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','. Note that delimiters are applied to the raw, binary data before the encoding is applied.
|
||||
"sourceFormat": "A String", # [Experimental] Optional and defaults to CSV. Format of source files. For CSV uploads, specify "CSV". For imports of datastore backups, specify "DATASTORE_BACKUP". For imports of newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
|
||||
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
|
||||
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
|
||||
"destinationTable": { # [Required] The destination table to load the data into.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
],
|
||||
"quote": "A String", # [Optional] Quote character to use. Default is '"'. Note that quoting is done on the raw, binary data before the encoding is applied. If no quoting is done, use am empty string.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
|
||||
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
|
||||
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
|
||||
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
|
||||
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -390,6 +391,7 @@ Args:
|
||||
},
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
@@ -472,34 +474,34 @@ Returns:
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','. Note that delimiters are applied to the raw, binary data before the encoding is applied.
|
||||
"sourceFormat": "A String", # [Experimental] Optional and defaults to CSV. Format of source files. For CSV uploads, specify "CSV". For imports of datastore backups, specify "DATASTORE_BACKUP". For imports of newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
|
||||
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
|
||||
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
|
||||
"destinationTable": { # [Required] The destination table to load the data into.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
],
|
||||
"quote": "A String", # [Optional] Quote character to use. Default is '"'. Note that quoting is done on the raw, binary data before the encoding is applied. If no quoting is done, use am empty string.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
|
||||
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
|
||||
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
|
||||
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
|
||||
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -528,6 +530,7 @@ Returns:
|
||||
},
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
@@ -634,34 +637,34 @@ Returns:
|
||||
"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
|
||||
"configuration": { # [Full-projection-only] Specifies the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','. Note that delimiters are applied to the raw, binary data before the encoding is applied.
|
||||
"sourceFormat": "A String", # [Experimental] Optional and defaults to CSV. Format of source files. For CSV uploads, specify "CSV". For imports of datastore backups, specify "DATASTORE_BACKUP". For imports of newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
|
||||
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
|
||||
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
|
||||
"destinationTable": { # [Required] The destination table to load the data into.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
],
|
||||
"quote": "A String", # [Optional] Quote character to use. Default is '"'. Note that quoting is done on the raw, binary data before the encoding is applied. If no quoting is done, use am empty string.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
|
||||
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
|
||||
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
|
||||
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
|
||||
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -690,6 +693,7 @@ Returns:
|
||||
},
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
@@ -795,12 +799,12 @@ Returns:
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -139,12 +139,12 @@ Returns:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -181,12 +181,12 @@ Args:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -216,12 +216,12 @@ Returns:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -306,12 +306,12 @@ Args:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -341,12 +341,12 @@ Returns:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -384,12 +384,12 @@ Args:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -419,12 +419,12 @@ Returns:
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -78,7 +78,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(blogId, maxPosts=None)</a></code></p>
|
||||
<p class="firstline">Gets one blog by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getByUrl">getByUrl(url=None)</a></code></p>
|
||||
<code><a href="#getByUrl">getByUrl(url)</a></code></p>
|
||||
<p class="firstline">Retrieve a Blog by URL.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listByUser">listByUser(userId)</a></code></p>
|
||||
@@ -186,11 +186,11 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getByUrl">getByUrl(url=None)</code>
|
||||
<code class="details" id="getByUrl">getByUrl(url)</code>
|
||||
<pre>Retrieve a Blog by URL.
|
||||
|
||||
Args:
|
||||
url: string, The URL of the blog to retrieve.
|
||||
url: string, The URL of the blog to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
@@ -81,7 +81,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(blogId, postId, maxComments=None)</a></code></p>
|
||||
<p class="firstline">Get a post by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getByPath">getByPath(blogId, path=None, maxComments=None)</a></code></p>
|
||||
<code><a href="#getByPath">getByPath(blogId, path, maxComments=None)</a></code></p>
|
||||
<p class="firstline">Retrieve a Post by Path.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(blogId, body)</a></code></p>
|
||||
@@ -96,7 +96,7 @@ h1, h2, h3 {
|
||||
<code><a href="#patch">patch(blogId, postId, body)</a></code></p>
|
||||
<p class="firstline">Update a post. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#search">search(blogId, q=None)</a></code></p>
|
||||
<code><a href="#search">search(blogId, q)</a></code></p>
|
||||
<p class="firstline">Search for a post.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(blogId, postId, body)</a></code></p>
|
||||
@@ -189,12 +189,12 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getByPath">getByPath(blogId, path=None, maxComments=None)</code>
|
||||
<code class="details" id="getByPath">getByPath(blogId, path, maxComments=None)</code>
|
||||
<pre>Retrieve a Post by Path.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
path: string, Path of the Post to retrieve.
|
||||
path: string, Path of the Post to retrieve. (required)
|
||||
maxComments: integer, Maximum number of comments to pull back on a post.
|
||||
|
||||
Returns:
|
||||
@@ -647,12 +647,12 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="search">search(blogId, q=None)</code>
|
||||
<code class="details" id="search">search(blogId, q)</code>
|
||||
<pre>Search for a post.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
q: string, Query terms to search this blog for matching posts.
|
||||
q: string, Query terms to search this blog for matching posts. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
@@ -130,6 +130,7 @@ Returns:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -169,6 +170,7 @@ Args:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -204,6 +206,7 @@ Returns:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -256,6 +259,7 @@ Returns:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -314,6 +318,7 @@ Args:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -349,6 +354,7 @@ Returns:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -389,6 +395,7 @@ Args:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
@@ -424,6 +431,7 @@ Returns:
|
||||
"description": "A String", # Description of the calendar. Optional. Read-only.
|
||||
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
|
||||
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
|
||||
"primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
|
||||
"summary": "A String", # Title of the calendar. Read-only.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
|
||||
|
||||
@@ -87,7 +87,7 @@ h1, h2, h3 {
|
||||
<code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
|
||||
<p class="firstline">Creates an event.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#instances">instances(calendarId, eventId, timeMin=None, pageToken=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
|
||||
<code><a href="#instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
|
||||
<p class="firstline">Returns instances of the specified recurring event.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>
|
||||
@@ -763,16 +763,16 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="instances">instances(calendarId, eventId, timeMin=None, pageToken=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
|
||||
<code class="details" id="instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
|
||||
<pre>Returns instances of the specified recurring event.
|
||||
|
||||
Args:
|
||||
calendarId: string, Calendar identifier. (required)
|
||||
eventId: string, Recurring event identifier. (required)
|
||||
timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
|
||||
pageToken: string, Token specifying which result page to return. Optional.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
|
||||
alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
|
||||
pageToken: string, Token specifying which result page to return. Optional.
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.
|
||||
timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
|
||||
@@ -958,7 +958,7 @@ Args:
|
||||
updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
|
||||
singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
|
||||
alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted single events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
|
||||
iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.
|
||||
|
||||
@@ -134,9 +134,7 @@ Returns:
|
||||
},
|
||||
},
|
||||
"supportsMediaUpload": True or False, # Whether this method supports media uploads.
|
||||
"request": { # The schema for the request.
|
||||
"$ref": "A String", # Schema ID for the request schema.
|
||||
},
|
||||
"etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
|
||||
"mediaUpload": { # Media upload parameters.
|
||||
"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
|
||||
"protocols": { # Supported upload protocols.
|
||||
@@ -153,6 +151,9 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"request": { # The schema for the request.
|
||||
"$ref": "A String", # Schema ID for the request schema.
|
||||
},
|
||||
"response": { # The schema for the response.
|
||||
"$ref": "A String", # Schema ID for the response schema.
|
||||
},
|
||||
@@ -291,9 +292,7 @@ Returns:
|
||||
},
|
||||
},
|
||||
"supportsMediaUpload": True or False, # Whether this method supports media uploads.
|
||||
"request": { # The schema for the request.
|
||||
"$ref": "A String", # Schema ID for the request schema.
|
||||
},
|
||||
"etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
|
||||
"mediaUpload": { # Media upload parameters.
|
||||
"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
|
||||
"protocols": { # Supported upload protocols.
|
||||
@@ -310,6 +309,9 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"request": { # The schema for the request.
|
||||
"$ref": "A String", # Schema ID for the request schema.
|
||||
},
|
||||
"response": { # The schema for the response.
|
||||
"$ref": "A String", # Schema ID for the response schema.
|
||||
},
|
||||
|
||||
@@ -98,14 +98,15 @@ Returns:
|
||||
"featureRate": 3.14, # The request limit rate for this feature, in queries per second.
|
||||
},
|
||||
],
|
||||
"quotaBytesUsed": "A String", # The number of quota bytes used.
|
||||
"quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive.
|
||||
"user": { # The JSON template for a user. # The authenticated user.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"permissionId": "A String", # The current user's ID as visible in the permissions collection.
|
||||
"maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence.
|
||||
|
||||
@@ -79,7 +79,7 @@ h1, h2, h3 {
|
||||
<p class="firstline">Gets a specific app.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list()</a></code></p>
|
||||
<p class="firstline">Lists a user's apps.</p>
|
||||
<p class="firstline">Lists a user's installed apps.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(appId)</code>
|
||||
@@ -91,7 +91,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Information about a third-party application which the user has installed or given access to Google Drive.
|
||||
{ # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
|
||||
"kind": "drive#app", # This is always drive#app.
|
||||
"primaryFileExtensions": [ # The list of primary file extensions.
|
||||
"A String",
|
||||
@@ -129,7 +129,7 @@ Returns:
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list()</code>
|
||||
<pre>Lists a user's apps.
|
||||
<pre>Lists a user's installed apps.
|
||||
|
||||
Args:
|
||||
|
||||
@@ -138,7 +138,7 @@ Returns:
|
||||
|
||||
{ # A list of third-party applications which the user has installed or given access to Google Drive.
|
||||
"items": [ # The actual list of apps.
|
||||
{ # Information about a third-party application which the user has installed or given access to Google Drive.
|
||||
{ # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
|
||||
"kind": "drive#app", # This is always drive#app.
|
||||
"primaryFileExtensions": [ # The list of primary file extensions.
|
||||
"A String",
|
||||
|
||||
@@ -99,7 +99,6 @@ Returns:
|
||||
"deleted": True or False, # Whether the file has been deleted.
|
||||
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
|
||||
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
|
||||
"appDataContents": True or False, # Whether this file is in the appdata folder.
|
||||
"thumbnailLink": "A String", # A link to the file's thumbnail.
|
||||
"labels": { # A group of labels for the file.
|
||||
"restricted": True or False, # Whether viewers are prevented from downloading this file.
|
||||
@@ -109,13 +108,33 @@ Returns:
|
||||
"trashed": True or False, # Whether this file has been trashed.
|
||||
},
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)
|
||||
"text": "A String", # The text to be indexed for this file
|
||||
"text": "A String", # The text to be indexed for this file.
|
||||
},
|
||||
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
|
||||
"etag": "A String", # ETag of the file.
|
||||
"lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
|
||||
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
|
||||
"writersCanShare": True or False, # Whether writers can share the document with other users.
|
||||
"id": "A String", # The id of the file.
|
||||
"owners": [ # The owner(s) of this file.
|
||||
{ # The JSON template for a user.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
],
|
||||
"id": "A String", # The ID of the file.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"title": "A String", # The title of this file.
|
||||
"ownerNames": [ # Name(s) of the owner(s) of this file.
|
||||
"A String",
|
||||
@@ -147,9 +166,9 @@ Returns:
|
||||
"editable": True or False, # Whether the file can be edited by the current user.
|
||||
"kind": "drive#file", # The type of file. This is always drive#file.
|
||||
"quotaBytesUsed": "A String", # The number of quota bytes used by this file.
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
|
||||
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
|
||||
"iconLink": "A String", # A link to the file's icon.
|
||||
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
|
||||
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
|
||||
@@ -181,8 +200,8 @@ Returns:
|
||||
"embedLink": "A String", # A link for embedding the file.
|
||||
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
"userPermission": { # A single permission for a file.
|
||||
"downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
|
||||
"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -205,7 +224,7 @@ Returns:
|
||||
],
|
||||
"selfLink": "A String", # A link back to this permission.
|
||||
},
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is set from the title when inserting or uploading new content. This will only be populated on files with content stored in Drive.
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
|
||||
"selfLink": "A String", # A link back to this file.
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
|
||||
},
|
||||
@@ -238,7 +257,6 @@ Returns:
|
||||
"deleted": True or False, # Whether the file has been deleted.
|
||||
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
|
||||
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
|
||||
"appDataContents": True or False, # Whether this file is in the appdata folder.
|
||||
"thumbnailLink": "A String", # A link to the file's thumbnail.
|
||||
"labels": { # A group of labels for the file.
|
||||
"restricted": True or False, # Whether viewers are prevented from downloading this file.
|
||||
@@ -248,13 +266,33 @@ Returns:
|
||||
"trashed": True or False, # Whether this file has been trashed.
|
||||
},
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)
|
||||
"text": "A String", # The text to be indexed for this file
|
||||
"text": "A String", # The text to be indexed for this file.
|
||||
},
|
||||
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
|
||||
"etag": "A String", # ETag of the file.
|
||||
"lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
|
||||
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
|
||||
"writersCanShare": True or False, # Whether writers can share the document with other users.
|
||||
"id": "A String", # The id of the file.
|
||||
"owners": [ # The owner(s) of this file.
|
||||
{ # The JSON template for a user.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
],
|
||||
"id": "A String", # The ID of the file.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"title": "A String", # The title of this file.
|
||||
"ownerNames": [ # Name(s) of the owner(s) of this file.
|
||||
"A String",
|
||||
@@ -286,9 +324,9 @@ Returns:
|
||||
"editable": True or False, # Whether the file can be edited by the current user.
|
||||
"kind": "drive#file", # The type of file. This is always drive#file.
|
||||
"quotaBytesUsed": "A String", # The number of quota bytes used by this file.
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
|
||||
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
|
||||
"iconLink": "A String", # A link to the file's icon.
|
||||
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
|
||||
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
|
||||
@@ -320,8 +358,8 @@ Returns:
|
||||
"embedLink": "A String", # A link for embedding the file.
|
||||
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
"userPermission": { # A single permission for a file.
|
||||
"downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
|
||||
"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -344,7 +382,7 @@ Returns:
|
||||
],
|
||||
"selfLink": "A String", # A link back to this permission.
|
||||
},
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is set from the title when inserting or uploading new content. This will only be populated on files with content stored in Drive.
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
|
||||
"selfLink": "A String", # A link back to this file.
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
|
||||
},
|
||||
|
||||
@@ -111,7 +111,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A reference to a file's child.
|
||||
{ # A reference to a folder's child.
|
||||
"kind": "drive#childReference", # This is always drive#childReference.
|
||||
"childLink": "A String", # A link to the child.
|
||||
"id": "A String", # The ID of the child.
|
||||
@@ -128,7 +128,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A reference to a file's child.
|
||||
{ # A reference to a folder's child.
|
||||
"kind": "drive#childReference", # This is always drive#childReference.
|
||||
"childLink": "A String", # A link to the child.
|
||||
"id": "A String", # The ID of the child.
|
||||
@@ -139,7 +139,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A reference to a file's child.
|
||||
{ # A reference to a folder's child.
|
||||
"kind": "drive#childReference", # This is always drive#childReference.
|
||||
"childLink": "A String", # A link to the child.
|
||||
"id": "A String", # The ID of the child.
|
||||
@@ -164,7 +164,7 @@ Returns:
|
||||
"nextPageToken": "A String", # The page token for the next page of children.
|
||||
"kind": "drive#childList", # This is always drive#childList.
|
||||
"items": [ # The actual list of children.
|
||||
{ # A reference to a file's child.
|
||||
{ # A reference to a folder's child.
|
||||
"kind": "drive#childReference", # This is always drive#childReference.
|
||||
"childLink": "A String", # A link to the child.
|
||||
"id": "A String", # The ID of the child.
|
||||
|
||||
@@ -129,8 +129,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -141,8 +142,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -190,8 +192,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -202,8 +205,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -245,8 +249,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -257,8 +262,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -314,8 +320,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -326,8 +333,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -393,8 +401,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -405,8 +414,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -448,8 +458,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -460,8 +471,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -510,8 +522,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -522,8 +535,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -565,8 +579,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
|
||||
"replies": [ # Replies to this post.
|
||||
@@ -577,8 +592,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -81,7 +81,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(fileId, permissionId)</a></code></p>
|
||||
<p class="firstline">Gets a permission by ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(fileId, body, sendNotificationEmails=None)</a></code></p>
|
||||
<code><a href="#insert">insert(fileId, body, sendNotificationEmails=None, emailMessage=None)</a></code></p>
|
||||
<p class="firstline">Inserts a permission for a file.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(fileId)</a></code></p>
|
||||
@@ -114,7 +114,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -140,7 +140,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(fileId, body, sendNotificationEmails=None)</code>
|
||||
<code class="details" id="insert">insert(fileId, body, sendNotificationEmails=None, emailMessage=None)</code>
|
||||
<pre>Inserts a permission for a file.
|
||||
|
||||
Args:
|
||||
@@ -148,7 +148,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -172,12 +172,13 @@ Args:
|
||||
"selfLink": "A String", # A link back to this permission.
|
||||
}
|
||||
|
||||
sendNotificationEmails: boolean, Whether to send notification emails.
|
||||
sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups.
|
||||
emailMessage: string, A custom message to include in notification emails.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -214,7 +215,7 @@ Returns:
|
||||
|
||||
{ # A list of permissions associated with a file.
|
||||
"items": [ # The actual list of permissions.
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -254,7 +255,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -282,7 +283,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -317,7 +318,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
@@ -345,7 +346,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single permission for a file.
|
||||
{ # A permission for a file.
|
||||
"withLink": True or False, # Whether the link is required for this permission.
|
||||
"kind": "drive#permission", # This is always drive#permission.
|
||||
"name": "A String", # The name for this permission.
|
||||
|
||||
@@ -127,8 +127,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -159,8 +160,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -184,8 +186,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -223,8 +226,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -273,8 +277,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -298,8 +303,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -331,8 +337,9 @@ Args:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
@@ -356,8 +363,9 @@ Returns:
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
|
||||
"htmlContent": "A String", # HTML formatted content for this reply.
|
||||
|
||||
@@ -111,12 +111,21 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
@@ -146,12 +155,21 @@ Returns:
|
||||
|
||||
{ # A list of revisions of a file.
|
||||
"items": [ # The actual list of revisions.
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
@@ -184,12 +202,21 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
@@ -210,12 +237,21 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
@@ -243,12 +279,21 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
@@ -269,12 +314,21 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A single revision of a file.
|
||||
{ # A revision of a file.
|
||||
"mimeType": "A String", # The MIME type of the revision.
|
||||
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
|
||||
"kind": "drive#revision", # This is always drive#revision.
|
||||
"publishedLink": "A String", # A link to the published revision.
|
||||
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
|
||||
"lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
|
||||
"picture": { # The user's profile picture.
|
||||
"url": "A String", # A URL that points to a profile picture of this user.
|
||||
},
|
||||
"kind": "drive#user", # This is always drive#user.
|
||||
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
|
||||
"displayName": "A String", # A plain text displayable name for this user.
|
||||
"permissionId": "A String", # The user's ID as visible in the permissions collection.
|
||||
},
|
||||
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
|
||||
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
|
||||
|
||||
@@ -78,7 +78,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(role, roleId, advertiserId=None)</a></code></p>
|
||||
<p class="firstline">Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(role, roleId, relationshipStatus=None, pageToken=None, advertiserCategory=None, minNinetyDayEpc=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</a></code></p>
|
||||
<code><a href="#list">list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</a></code></p>
|
||||
<p class="firstline">Retrieves data about all advertisers that the requesting advertiser/publisher has access to.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
@@ -135,7 +135,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(role, roleId, relationshipStatus=None, pageToken=None, advertiserCategory=None, minNinetyDayEpc=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</code>
|
||||
<code class="details" id="list">list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</code>
|
||||
<pre>Retrieves data about all advertisers that the requesting advertiser/publisher has access to.
|
||||
|
||||
Args:
|
||||
@@ -152,8 +152,8 @@ Args:
|
||||
declined - An advertiser that did not approve your application.
|
||||
pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
|
||||
advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
|
||||
minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
|
||||
advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
|
||||
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
|
||||
minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
|
||||
minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.
|
||||
|
||||
@@ -99,4 +99,9 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the publishers Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="gan_v1beta1.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
</body></html>
|
||||
@@ -84,6 +84,11 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the comments Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="plus_v1.moments.html">moments()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the moments Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="plus_v1.people.html">people()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -76,13 +76,19 @@ h1, h2, h3 {
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(userId)</a></code></p>
|
||||
<p class="firstline">Get a person's profile.</p>
|
||||
<p class="firstline">Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all of the people in the specified collection.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all of the people in the specified collection for a particular activity.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listByActivity_next">listByActivity_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#search">search(query, pageToken=None, language=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Search all public profiles.</p>
|
||||
@@ -92,7 +98,7 @@ h1, h2, h3 {
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(userId)</code>
|
||||
<pre>Get a person's profile.
|
||||
<pre>Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
|
||||
|
||||
Args:
|
||||
userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
|
||||
@@ -115,8 +121,17 @@ Returns:
|
||||
"currentLocation": "A String", # The current location for this person.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
"circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"aboutMe": "A String", # A short biography for this person.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"placesLived": [ # A list of places where this person has lived.
|
||||
{
|
||||
"primary": True or False, # If "true", this place of residence is this person's primary residence.
|
||||
@@ -125,7 +140,7 @@ Returns:
|
||||
],
|
||||
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
|
||||
"nickname": "A String", # The nickname of this person.
|
||||
"emails": [ # A list of email addresses for this person.
|
||||
"emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
|
||||
{
|
||||
"type": "A String", # The type of address. Possible values are:
|
||||
# - "home" - Home email address.
|
||||
@@ -150,16 +165,7 @@ Returns:
|
||||
"name": "A String", # The name of the organization.
|
||||
},
|
||||
],
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"displayName": "A String", # The name of this person, suitable for display.
|
||||
"name": { # An object representation of the individual components of a person's name.
|
||||
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
|
||||
@@ -169,6 +175,7 @@ Returns:
|
||||
"givenName": "A String", # The given name (first name) of this person.
|
||||
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
|
||||
},
|
||||
"language": "A String", # The user's preferred language for rendering.
|
||||
"url": "A String", # The URL of this person's profile.
|
||||
"gender": "A String", # The person's gender. Possible values are:
|
||||
# - "male" - Male gender.
|
||||
@@ -201,6 +208,148 @@ Returns:
|
||||
"value": "A String", # The URL value.
|
||||
},
|
||||
],
|
||||
"ageRange": { # The age range of the person.
|
||||
"max": 42, # The age range's upper bound, if any.
|
||||
"min": 42, # The age range's lower bound, if any.
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all of the people in the specified collection.
|
||||
|
||||
Args:
|
||||
userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
|
||||
collection: string, The collection of people to list. (required)
|
||||
Allowed values
|
||||
visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
|
||||
orderBy: string, The order to return people in.
|
||||
Allowed values
|
||||
alphabetical - Order the people by their display name.
|
||||
best - Order people based on the relevence to the viewer.
|
||||
pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
||||
"kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
|
||||
"title": "A String", # The title of this collection of people.
|
||||
"items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
|
||||
{
|
||||
"braggingRights": "A String", # The "bragging rights" line of this person.
|
||||
"image": { # The representation of the person's profile photo.
|
||||
"url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
|
||||
},
|
||||
"hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
|
||||
"id": "A String", # The ID of this person.
|
||||
"objectType": "A String", # Type of person within Google+. Possible values are:
|
||||
# - "person" - represents an actual person.
|
||||
# - "page" - represents a page.
|
||||
"verified": True or False, # Whether the person or Google+ Page has been verified.
|
||||
"tagline": "A String", # The brief description (tagline) of this person.
|
||||
"currentLocation": "A String", # The current location for this person.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
"circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"aboutMe": "A String", # A short biography for this person.
|
||||
"placesLived": [ # A list of places where this person has lived.
|
||||
{
|
||||
"primary": True or False, # If "true", this place of residence is this person's primary residence.
|
||||
"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
|
||||
},
|
||||
],
|
||||
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
|
||||
"nickname": "A String", # The nickname of this person.
|
||||
"emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
|
||||
{
|
||||
"type": "A String", # The type of address. Possible values are:
|
||||
# - "home" - Home email address.
|
||||
# - "work" - Work email address.
|
||||
# - "other" - Other.
|
||||
"primary": True or False, # If "true", indicates this email address is the person's primary one.
|
||||
"value": "A String", # The email address.
|
||||
},
|
||||
],
|
||||
"organizations": [ # A list of current or past organizations with which this person is associated.
|
||||
{
|
||||
"startDate": "A String", # The date the person joined this organization.
|
||||
"endDate": "A String", # The date the person left this organization.
|
||||
"description": "A String", # A short description of the person's role in this organization. Deprecated.
|
||||
"title": "A String", # The person's job title or role within the organization.
|
||||
"primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
|
||||
"location": "A String", # The location of this organization. Deprecated.
|
||||
"department": "A String", # The department within the organization. Deprecated.
|
||||
"type": "A String", # The type of organization. Possible values are:
|
||||
# - "work" - Work.
|
||||
# - "school" - School.
|
||||
"name": "A String", # The name of the organization.
|
||||
},
|
||||
],
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"displayName": "A String", # The name of this person, suitable for display.
|
||||
"name": { # An object representation of the individual components of a person's name.
|
||||
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
|
||||
"middleName": "A String", # The middle name of this person.
|
||||
"familyName": "A String", # The family name (last name) of this person.
|
||||
"formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
|
||||
"givenName": "A String", # The given name (first name) of this person.
|
||||
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
|
||||
},
|
||||
"language": "A String", # The user's preferred language for rendering.
|
||||
"url": "A String", # The URL of this person's profile.
|
||||
"gender": "A String", # The person's gender. Possible values are:
|
||||
# - "male" - Male gender.
|
||||
# - "female" - Female gender.
|
||||
# - "other" - Other.
|
||||
"cover": { # The cover photo content.
|
||||
"layout": "A String", # The layout of the cover art. Possible values are:
|
||||
# - "banner" - One large image banner.
|
||||
"coverInfo": { # Extra information about the cover photo.
|
||||
"leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
|
||||
"topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
|
||||
},
|
||||
"coverPhoto": { # The person's primary cover image.
|
||||
"url": "A String", # The url to the image.
|
||||
"width": 42, # The width to the image.
|
||||
"height": 42, # The height to the image.
|
||||
},
|
||||
},
|
||||
"isPlusUser": True or False, # Whether this user has signed up for Google+.
|
||||
"plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
|
||||
"urls": [ # A list of URLs for this person.
|
||||
{
|
||||
"type": "A String", # The type of URL. Possible values are:
|
||||
# - "home" - URL for home.
|
||||
# - "work" - URL for work.
|
||||
# - "blog" - URL for blog.
|
||||
# - "profile" - URL for profile.
|
||||
# - "other" - Other.
|
||||
"primary": True or False, # If "true", this URL is the person's primary URL.
|
||||
"value": "A String", # The URL value.
|
||||
},
|
||||
],
|
||||
"ageRange": { # The age range of the person.
|
||||
"max": 42, # The age range's upper bound, if any.
|
||||
"min": 42, # The age range's lower bound, if any.
|
||||
},
|
||||
},
|
||||
],
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
"totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
|
||||
"selfLink": "A String", # Link to this resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -240,8 +389,17 @@ Returns:
|
||||
"currentLocation": "A String", # The current location for this person.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
"circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"aboutMe": "A String", # A short biography for this person.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"placesLived": [ # A list of places where this person has lived.
|
||||
{
|
||||
"primary": True or False, # If "true", this place of residence is this person's primary residence.
|
||||
@@ -250,7 +408,7 @@ Returns:
|
||||
],
|
||||
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
|
||||
"nickname": "A String", # The nickname of this person.
|
||||
"emails": [ # A list of email addresses for this person.
|
||||
"emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
|
||||
{
|
||||
"type": "A String", # The type of address. Possible values are:
|
||||
# - "home" - Home email address.
|
||||
@@ -275,16 +433,7 @@ Returns:
|
||||
"name": "A String", # The name of the organization.
|
||||
},
|
||||
],
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"displayName": "A String", # The name of this person, suitable for display.
|
||||
"name": { # An object representation of the individual components of a person's name.
|
||||
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
|
||||
@@ -294,6 +443,7 @@ Returns:
|
||||
"givenName": "A String", # The given name (first name) of this person.
|
||||
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
|
||||
},
|
||||
"language": "A String", # The user's preferred language for rendering.
|
||||
"url": "A String", # The URL of this person's profile.
|
||||
"gender": "A String", # The person's gender. Possible values are:
|
||||
# - "male" - Male gender.
|
||||
@@ -326,6 +476,10 @@ Returns:
|
||||
"value": "A String", # The URL value.
|
||||
},
|
||||
],
|
||||
"ageRange": { # The age range of the person.
|
||||
"max": 42, # The age range's upper bound, if any.
|
||||
"min": 42, # The age range's lower bound, if any.
|
||||
},
|
||||
},
|
||||
],
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
@@ -348,6 +502,20 @@ Returns:
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
||||
<pre>Retrieves the next page of results.
|
||||
|
||||
Args:
|
||||
previous_request: The request for the previous page. (required)
|
||||
previous_response: The response from the request for the previous page. (required)
|
||||
|
||||
Returns:
|
||||
A request object that you can call 'execute()' on to request the next
|
||||
page. Returns None if there are no more items in the collection.
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="search">search(query, pageToken=None, language=None, maxResults=None)</code>
|
||||
<pre>Search all public profiles.
|
||||
@@ -381,8 +549,17 @@ Returns:
|
||||
"currentLocation": "A String", # The current location for this person.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
"circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"aboutMe": "A String", # A short biography for this person.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"placesLived": [ # A list of places where this person has lived.
|
||||
{
|
||||
"primary": True or False, # If "true", this place of residence is this person's primary residence.
|
||||
@@ -391,7 +568,7 @@ Returns:
|
||||
],
|
||||
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
|
||||
"nickname": "A String", # The nickname of this person.
|
||||
"emails": [ # A list of email addresses for this person.
|
||||
"emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
|
||||
{
|
||||
"type": "A String", # The type of address. Possible values are:
|
||||
# - "home" - Home email address.
|
||||
@@ -416,16 +593,7 @@ Returns:
|
||||
"name": "A String", # The name of the organization.
|
||||
},
|
||||
],
|
||||
"relationshipStatus": "A String", # The person's relationship status. Possible values are:
|
||||
# - "single" - Person is single.
|
||||
# - "in_a_relationship" - Person is in a relationship.
|
||||
# - "engaged" - Person is engaged.
|
||||
# - "married" - Person is married.
|
||||
# - "its_complicated" - The relationship is complicated.
|
||||
# - "open_relationship" - Person is in an open relationship.
|
||||
# - "widowed" - Person is widowed.
|
||||
# - "in_domestic_partnership" - Person is in a domestic partnership.
|
||||
# - "in_civil_union" - Person is in a civil union.
|
||||
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
|
||||
"displayName": "A String", # The name of this person, suitable for display.
|
||||
"name": { # An object representation of the individual components of a person's name.
|
||||
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
|
||||
@@ -435,6 +603,7 @@ Returns:
|
||||
"givenName": "A String", # The given name (first name) of this person.
|
||||
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
|
||||
},
|
||||
"language": "A String", # The user's preferred language for rendering.
|
||||
"url": "A String", # The URL of this person's profile.
|
||||
"gender": "A String", # The person's gender. Possible values are:
|
||||
# - "male" - Male gender.
|
||||
@@ -467,6 +636,10 @@ Returns:
|
||||
"value": "A String", # The URL value.
|
||||
},
|
||||
],
|
||||
"ageRange": { # The age range of the person.
|
||||
"max": 42, # The age range's upper bound, if any.
|
||||
"min": 42, # The age range's lower bound, if any.
|
||||
},
|
||||
},
|
||||
],
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
|
||||
@@ -78,7 +78,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(source, accountId, productIdType, productId, taxonomy=None, recommendations_useGcsConfig=None, plusOne_enabled=None, recommendations_include=None, location=None, recommendations_enabled=None, categories_enabled=None, attributeFilter=None, categories_useGcsConfig=None, plusOne_styles=None, thumbnails=None, categories_include=None, plusOne_useGcsConfig=None)</a></code></p>
|
||||
<p class="firstline">Returns a single product</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, plusOne_styles=None, plusOne_enabled=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, plusOne_useGcsConfig=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None, country=None)</a></code></p>
|
||||
<code><a href="#list">list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, experimentId=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, plusOne_styles=None, plusOne_enabled=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, plusOne_useGcsConfig=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None, country=None)</a></code></p>
|
||||
<p class="firstline">Returns a list of products and content modules</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
@@ -353,7 +353,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, plusOne_styles=None, plusOne_enabled=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, plusOne_useGcsConfig=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None, country=None)</code>
|
||||
<code class="details" id="list">list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, experimentId=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, plusOne_styles=None, plusOne_enabled=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, plusOne_useGcsConfig=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None, country=None)</code>
|
||||
<pre>Returns a list of products and content modules
|
||||
|
||||
Args:
|
||||
@@ -362,6 +362,7 @@ Args:
|
||||
rankBy: string, Ranking specification
|
||||
taxonomy: string, Taxonomy name
|
||||
promotions_enabled: boolean, Whether to return promotion information
|
||||
experimentId: string, The Id of the experiment
|
||||
channels: string, Channels specification
|
||||
facets_discover: string, Facets to discover
|
||||
startIndex: integer, Index (1-based) of first product to return
|
||||
|
||||
@@ -137,7 +137,7 @@ Returns:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -213,7 +213,7 @@ Args:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -271,7 +271,7 @@ Returns:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -329,7 +329,7 @@ Args:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -411,7 +411,7 @@ Returns:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -490,7 +490,7 @@ Args:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -546,7 +546,7 @@ Returns:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -605,7 +605,7 @@ Args:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -661,7 +661,7 @@ Returns:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
@@ -720,7 +720,7 @@ Args:
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
"algorithm": "A String", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
|
||||
"length": "A String", # Content-Length of the data in bytes.
|
||||
"link": "A String", # Media download link.
|
||||
"hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
|
||||
|
||||
@@ -75,21 +75,23 @@ h1, h2, h3 {
|
||||
<h1><a href="youtubeAnalytics_v1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1.reports.html">reports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#query">query(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</a></code></p>
|
||||
<code><a href="#query">query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</a></code></p>
|
||||
<p class="firstline">Retrieve your YouTube Analytics reports.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="query">query(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</code>
|
||||
<code class="details" id="query">query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</code>
|
||||
<pre>Retrieve your YouTube Analytics reports.
|
||||
|
||||
Args:
|
||||
ids: string, Unique channel or content owner ID for retrieving YouTube Analytics data. Either channel==C or contentOwner==O where 'C' is the encrypted channel ID and 'O' is the content owner name. (required)
|
||||
start_date: string, Start date for fetching YouTube Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
|
||||
end_date: string, End date for fetching YouTube Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
|
||||
metrics: string, A comma-separated list of YouTube Analytics metrics. E.g., 'views' or 'likes,dislikes' (required)
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending, '-' prefix causes descending sort order.
|
||||
dimensions: string, A comma-separated list of YouTube Analytics dimensions. E.g., 'video', or 'ageGroup,gender'.
|
||||
filters: string, A list of dimension filters to be applied to YouTube Analytics data. Multiple filters can be joined together with the ';' character. The returned result table will satisfy both filters. E.g., video==dMH0bHeiRNg;country==IT will restrict the returned stats to the given video and the country Italy.
|
||||
ids: string, Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
|
||||
- To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
|
||||
- To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. (required)
|
||||
start_date: string, The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
|
||||
end_date: string, The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
|
||||
metrics: string, A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. (required)
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order.
|
||||
dimensions: string, A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.
|
||||
filters: string, A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy.
|
||||
max_results: integer, The maximum number of rows to include in the response.
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).
|
||||
|
||||
@@ -97,16 +99,16 @@ Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes).
|
||||
"kind": "youtubeAnalytics#resultTable", # Identifier used to mark the structure as a result table.
|
||||
"rows": [ # Contains all rows of the result table. Each row contains an array with the values for the columns. The order matches the order of the column information provided in the "columnHeaders" field. If no data is available for the given query, the "rows" element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.
|
||||
"kind": "youtubeAnalytics#resultTable", # This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable.
|
||||
"rows": [ # The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.
|
||||
[
|
||||
"",
|
||||
],
|
||||
],
|
||||
"columnHeaders": [ # Contains information about the columns returned in the "rows" fields. The order of the elements matches the order of the corresponding columns in "rows" field.
|
||||
"columnHeaders": [ # This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage.
|
||||
{
|
||||
"dataType": "A String", # Type of the data in the column (STRING, INTEGER, FLOAT).
|
||||
"columnType": "A String", # The type of the column (DIMENSION, METRIC).
|
||||
"dataType": "A String", # The type of the data in the column (STRING, INTEGER, FLOAT, etc.).
|
||||
"columnType": "A String", # The type of the column (DIMENSION or METRIC).
|
||||
"name": "A String", # The name of the dimension or metric.
|
||||
},
|
||||
],
|
||||
|
||||
@@ -98,15 +98,16 @@ The part names that you can include in the parameter value are snippet and conte
|
||||
{ # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
|
||||
"snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
|
||||
"thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
"title": "A String", # The title of the resource primarily associated with the activity.
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
|
||||
"publishedAt": "A String", # The date and time that the activity occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel responsible for this activity
|
||||
"type": "A String", # The type of activity that the resource describes.
|
||||
"groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
|
||||
"description": "A String", # The description of the resource primarily associated with the activity.
|
||||
@@ -213,15 +214,16 @@ Returns:
|
||||
{ # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
|
||||
"snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
|
||||
"thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
"title": "A String", # The title of the resource primarily associated with the activity.
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
|
||||
"publishedAt": "A String", # The date and time that the activity occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel responsible for this activity
|
||||
"type": "A String", # The type of activity that the resource describes.
|
||||
"groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
|
||||
"description": "A String", # The description of the resource primarily associated with the activity.
|
||||
@@ -348,15 +350,16 @@ Returns:
|
||||
{ # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
|
||||
"snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
|
||||
"thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
"title": "A String", # The title of the resource primarily associated with the activity.
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
|
||||
"publishedAt": "A String", # The date and time that the activity occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel responsible for this activity
|
||||
"type": "A String", # The type of activity that the resource describes.
|
||||
"groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
|
||||
"description": "A String", # The description of the resource primarily associated with the activity.
|
||||
|
||||
@@ -75,24 +75,25 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.channels.html">channels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(part=None, pageToken=None, mine=None, maxResults=None, categoryId=None, mySubscribers=None, id=None)</a></code></p>
|
||||
<code><a href="#list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</a></code></p>
|
||||
<p class="firstline">Returns a collection of zero or more channel resources that match the request criteria.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(part=None, pageToken=None, mine=None, maxResults=None, categoryId=None, mySubscribers=None, id=None)</code>
|
||||
<code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</code>
|
||||
<pre>Returns a collection of zero or more channel resources that match the request criteria.
|
||||
|
||||
Args:
|
||||
part: string, The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, and topicDetails.
|
||||
|
||||
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. (required)
|
||||
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
|
||||
pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
|
||||
mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
|
||||
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
|
||||
categoryId: string, The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
|
||||
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
|
||||
mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
|
||||
mySubscribers: string, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
|
||||
id: string, The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
|
||||
|
||||
@@ -127,17 +128,96 @@ Returns:
|
||||
"favorites": "A String", # The ID of the playlist that contains the channel's favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
|
||||
"uploads": "A String", # The ID of the playlist that contains the channel's uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
|
||||
},
|
||||
"googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
|
||||
},
|
||||
"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
|
||||
"image": {
|
||||
"largeBrandedBannerImageUrl": { # Represent a property available in different languages.
|
||||
"default": "A String",
|
||||
"localizeds": [
|
||||
{ # A localized string.
|
||||
"value": "A String",
|
||||
"language": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"bannerImageUrl": "A String",
|
||||
"backgroundImageUrl": { # Represent a property available in different languages.
|
||||
"default": "A String",
|
||||
"localizeds": [
|
||||
{ # A localized string.
|
||||
"value": "A String",
|
||||
"language": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"largeBrandedBannerImageImapScript": { # Represent a property available in different languages.
|
||||
"default": "A String",
|
||||
"localizeds": [
|
||||
{ # A localized string.
|
||||
"value": "A String",
|
||||
"language": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"bannerMobileImageUrl": "A String",
|
||||
"smallBrandedBannerImageUrl": { # Represent a property available in different languages.
|
||||
"default": "A String",
|
||||
"localizeds": [
|
||||
{ # A localized string.
|
||||
"value": "A String",
|
||||
"language": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"smallBrandedBannerImageImapScript": { # Represent a property available in different languages.
|
||||
"default": "A String",
|
||||
"localizeds": [
|
||||
{ # A localized string.
|
||||
"value": "A String",
|
||||
"language": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"trackingImageUrl": "A String",
|
||||
"watchIconImageUrl": "A String",
|
||||
},
|
||||
"watch": { # Branding properties for the watch.
|
||||
"textColor": "A String",
|
||||
"featuredPlaylistId": "A String",
|
||||
"backgroundColor": "A String",
|
||||
},
|
||||
"channel": { # Branding properties for the channel view.
|
||||
"description": "A String",
|
||||
"title": "A String",
|
||||
"moderateComments": True or False,
|
||||
"showBrowseView": True or False,
|
||||
"featuredChannelsTitle": "A String",
|
||||
"unsubscribedTrailer": "A String",
|
||||
"keywords": "A String",
|
||||
"defaultTab": "A String",
|
||||
"featuredChannelsUrls": [
|
||||
"A String",
|
||||
],
|
||||
"trackingAnalyticsAccountId": "A String",
|
||||
"showRelatedChannels": True or False,
|
||||
},
|
||||
"hints": [
|
||||
{ # A key value for the experimental branding properties.
|
||||
"property": "A String",
|
||||
"value": "A String",
|
||||
},
|
||||
],
|
||||
},
|
||||
"snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
|
||||
"title": "A String", # The channel's title.
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel.
|
||||
"description": "A String", # The channel's description.
|
||||
"description": "A String", # The description of the channel.
|
||||
"publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@@ -89,6 +89,16 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the guideCategories Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="youtube_v3.liveBroadcasts.html">liveBroadcasts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the liveBroadcasts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="youtube_v3.liveStreams.html">liveStreams()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the liveStreams Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="youtube_v3.playlistItems.html">playlistItems()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -81,7 +81,7 @@ h1, h2, h3 {
|
||||
<code><a href="#insert">insert(part=None, body)</a></code></p>
|
||||
<p class="firstline">Adds a resource to a playlist.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(part=None, pageToken=None, playlistId=None, maxResults=None, id=None)</a></code></p>
|
||||
<code><a href="#list">list(part=None, pageToken=None, playlistId=None, videoId=None, maxResults=None, id=None)</a></code></p>
|
||||
<p class="firstline">Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
@@ -134,10 +134,10 @@ The part names that you can include in the parameter value are snippet and conte
|
||||
"publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -180,10 +180,10 @@ Returns:
|
||||
"publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -200,7 +200,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(part=None, pageToken=None, playlistId=None, maxResults=None, id=None)</code>
|
||||
<code class="details" id="list">list(part=None, pageToken=None, playlistId=None, videoId=None, maxResults=None, id=None)</code>
|
||||
<pre>Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.
|
||||
|
||||
Args:
|
||||
@@ -209,6 +209,7 @@ Args:
|
||||
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. (required)
|
||||
pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
|
||||
playlistId: string, The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter.
|
||||
videoId: string, The videoId parameter specifies that the request should return only the playlist items that contain the specified video.
|
||||
maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
|
||||
id: string, The id parameter specifies a comma-separated list of one or more unique playlist item IDs.
|
||||
|
||||
@@ -243,10 +244,10 @@ Returns:
|
||||
"publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -321,10 +322,10 @@ Note that this method will override the existing values for all of the mutable p
|
||||
"publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -367,10 +368,10 @@ Returns:
|
||||
"publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@@ -133,10 +133,10 @@ The part names that you can include in the parameter value are snippet and statu
|
||||
"description": "A String", # The playlist's description.
|
||||
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -174,10 +174,10 @@ Returns:
|
||||
"description": "A String", # The playlist's description.
|
||||
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -233,10 +233,10 @@ Returns:
|
||||
"description": "A String", # The playlist's description.
|
||||
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -306,10 +306,10 @@ Note that this method will override the existing values for all of the mutable p
|
||||
"description": "A String", # The playlist's description.
|
||||
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -347,10 +347,10 @@ Returns:
|
||||
"description": "A String", # The playlist's description.
|
||||
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@@ -75,14 +75,14 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.search.html">search</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(part=None, channelId=None, videoSyndicated=None, videoCaption=None, publishedAfter=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, relatedToVideoId=None, videoDefinition=None, pageToken=None, videoDuration=None, q=None, videoEmbeddable=None, videoCategoryId=None, order=None)</a></code></p>
|
||||
<code><a href="#list">list(part=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, videoDuration=None, q=None, videoEmbeddable=None, videoCategoryId=None, order=None)</a></code></p>
|
||||
<p class="firstline">Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(part=None, channelId=None, videoSyndicated=None, videoCaption=None, publishedAfter=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, relatedToVideoId=None, videoDefinition=None, pageToken=None, videoDuration=None, q=None, videoEmbeddable=None, videoCategoryId=None, order=None)</code>
|
||||
<code class="details" id="list">list(part=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, videoDuration=None, q=None, videoEmbeddable=None, videoCategoryId=None, order=None)</code>
|
||||
<pre>Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.
|
||||
|
||||
Args:
|
||||
@@ -94,12 +94,18 @@ If the parameter identifies a property that contains child properties, the child
|
||||
Allowed values
|
||||
any - Return all videos, syndicated or not.
|
||||
true - Only retrieve syndicated videos.
|
||||
channelType: string, The channelType parameter lets you restrict a search to a particular type of channel.
|
||||
Allowed values
|
||||
any - Return all channels.
|
||||
show - Only retrieve shows.
|
||||
videoCaption: string, The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.
|
||||
Allowed values
|
||||
any - Do not filter results based on caption availability.
|
||||
closedCaption - Only include videos that have captions.
|
||||
none - Only include videos that do not have captions.
|
||||
publishedAfter: string, The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
|
||||
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
|
||||
forContentOwner: boolean, The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
|
||||
regionCode: string, The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
|
||||
type: string, The type parameter restricts a search query to only retrieve a particular type of resource.
|
||||
topicId: string, The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.
|
||||
@@ -115,13 +121,18 @@ If the parameter identifies a property that contains child properties, the child
|
||||
creativeCommon - Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.
|
||||
youtube - Only return videos that have the standard YouTube license.
|
||||
maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
|
||||
relatedToVideoId: string, The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.
|
||||
videoType: string, The videoType parameter lets you restrict a search to a particular type of videos.
|
||||
Allowed values
|
||||
any - Return all videos.
|
||||
episode - Only retrieve episodes of shows.
|
||||
movie - Only retrieve movies.
|
||||
videoDefinition: string, The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.
|
||||
Allowed values
|
||||
any - Return all videos, regardless of their resolution.
|
||||
high - Only retrieve HD videos.
|
||||
standard - Only retrieve videos in standard definition.
|
||||
pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
|
||||
relatedToVideoId: string, The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.
|
||||
videoDuration: string, The videoDuration parameter filters video search results based on their duration.
|
||||
Allowed values
|
||||
any - Do not filter video search results based on their duration. This is the default value.
|
||||
@@ -149,23 +160,24 @@ Returns:
|
||||
"kind": "youtube#searchListResponse", # The type of the API response. For this operation, the value will be youtube#searchListResponse.
|
||||
"items": [ # A list of results that match the search criteria.
|
||||
{ # A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.
|
||||
"snippet": { # Basic details about a search result, including title, description and thumbnails of the item referenced by the search result. # The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.
|
||||
"title": "A String", # The title to display for the search result.
|
||||
"channelId": "A String", # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
|
||||
"description": "A String", # A description of the search result.
|
||||
"publishedAt": "A String", # The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"snippet": { # The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.
|
||||
"thumbnails": { # A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
"title": "A String", # The title of the search result.
|
||||
"channelId": "A String", # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
|
||||
"publishedAt": "A String", # The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # The title of the channel that published the resource that the search result identifies.
|
||||
"description": "A String", # A description of the search result.
|
||||
},
|
||||
"kind": "youtube#searchResult", # The type of the API response. For this resource, the value will be youtube#searchResult.
|
||||
"etag": "A String", # The ETag of the search result.
|
||||
"kind": "youtube#searchResult", # The kind, fixed to "youtube#searchResult".
|
||||
"etag": "A String", # Etag of this resource.
|
||||
"id": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that matches the search request.
|
||||
"kind": "A String", # The kind, or type, of the referred resource.
|
||||
"kind": "A String",
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
|
||||
"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
|
||||
"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
|
||||
|
||||
@@ -120,10 +120,10 @@ The part names that you can include in the parameter value are snippet and conte
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
|
||||
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the subscription. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -153,10 +153,10 @@ Returns:
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
|
||||
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the subscription. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -210,10 +210,10 @@ Returns:
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
|
||||
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"thumbnails": { # A map of thumbnail images associated with the subscription. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # The thumbnail image's name.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@@ -94,9 +94,9 @@ Returns:
|
||||
{ # A paginated list of video categories returned as the response to a youtube.videoCategory.list call.
|
||||
"items": [ # A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource.
|
||||
{ # A videoCategory resource identifies a category that has been or could be associated with uploaded videos.
|
||||
"snippet": { # Basic details about a video category, such as its localized title. # The snippet object contains basic details about the video category, including its title.
|
||||
"snippet": { # The snippet object contains basic details about the video category, including its title.
|
||||
"channelId": "UCBR8-60-B28hp2BmDPdntcQ", # The YouTube channel that created the video category.
|
||||
"title": "A String", # The video category's title.
|
||||
"title": "A String",
|
||||
},
|
||||
"kind": "youtube#videoCategory", # The type of the API resource. For video category resources, the value will be youtube#videoCategory.
|
||||
"etag": "A String", # The ETag of the videoCategory resource.
|
||||
|
||||
@@ -75,24 +75,25 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.videos.html">videos</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(id)</a></code></p>
|
||||
<code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
|
||||
<p class="firstline">Deletes a YouTube video.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(part=None, body=None, media_body=None)</a></code></p>
|
||||
<p class="firstline">Uploads a video to YouTube and optionally sets the video's metadata.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(id, part=None)</a></code></p>
|
||||
<code><a href="#list">list(id, part=None, onBehalfOfContentOwner=None)</a></code></p>
|
||||
<p class="firstline">Returns a list of videos that match the API request parameters.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(part=None, body)</a></code></p>
|
||||
<code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
|
||||
<p class="firstline">Updates a video's metadata.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(id)</code>
|
||||
<code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
|
||||
<pre>Deletes a YouTube video.
|
||||
|
||||
Args:
|
||||
id: string, The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. (required)
|
||||
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
@@ -109,15 +110,30 @@ The part names that you can include in the parameter value are snippet, contentD
|
||||
|
||||
{ # A video resource represents a YouTube video.
|
||||
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
|
||||
"license": "A String", # The video's license.
|
||||
"embeddable": True or False, # This value indicates if the video can be embedded on another website.
|
||||
"privacyStatus": "A String", # The video's privacy status.
|
||||
"uploadStatus": "A String", # The status of the uploaded video.
|
||||
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
|
||||
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
|
||||
},
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"description": "A String", # The video's description.
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel that the video belongs to.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
|
||||
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
|
||||
@@ -127,9 +143,29 @@ The part names that you can include in the parameter value are snippet, contentD
|
||||
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
|
||||
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
|
||||
},
|
||||
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
|
||||
"access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
},
|
||||
"contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
|
||||
"countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
"caption": "A String", # The value of captions indicates whether the video has captions or not.
|
||||
"regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
|
||||
"A String",
|
||||
],
|
||||
@@ -137,28 +173,97 @@ The part names that you can include in the parameter value are snippet, contentD
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
|
||||
"dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
|
||||
},
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
},
|
||||
},
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
|
||||
"processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"description": "A String", # The video's description.
|
||||
"tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
|
||||
{ # A single tag suggestion with it's relevance information.
|
||||
"categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
|
||||
"A String",
|
||||
],
|
||||
"tag": "A String", # The keyword tag suggested for the video.
|
||||
},
|
||||
],
|
||||
"editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
|
||||
"A String",
|
||||
],
|
||||
"processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
|
||||
"A String",
|
||||
],
|
||||
"processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
|
||||
"bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
|
||||
"container": "A String", # The uploaded video file's container format.
|
||||
"recordingLocation": { # A geoPoint holds geo location information associated with a YouTube resource. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
|
||||
"latitude": 3.14, # Latitude in degrees.
|
||||
"elevation": 3.14, # Altitude above the Earth, in meters.
|
||||
"longitude": 3.14, # Longitude in degrees.
|
||||
},
|
||||
"fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
|
||||
"creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
|
||||
# - Date only: YYYY-MM-DD
|
||||
# - Naive time: YYYY-MM-DDTHH:MM:SS
|
||||
# - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
|
||||
"durationMs": "A String", # The length of the uploaded video in milliseconds.
|
||||
"fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
|
||||
"fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
|
||||
"videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
|
||||
{ # Information about a video stream.
|
||||
"bitrateBps": "A String", # The video stream's bitrate, in bits per second.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"codec": "A String", # The video codec that the stream uses.
|
||||
"widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
|
||||
"heightPixels": 42, # The encoded video content's height in pixels.
|
||||
"aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
|
||||
"rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
|
||||
"frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
|
||||
},
|
||||
],
|
||||
"audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
|
||||
{ # Information about an audio stream.
|
||||
"bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
|
||||
"codec": "A String", # The audio codec that the stream uses.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"channelCount": 42, # The number of audio channels that the stream contains.
|
||||
},
|
||||
],
|
||||
},
|
||||
"processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
|
||||
#
|
||||
# The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
|
||||
"fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
|
||||
"editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
|
||||
"processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
|
||||
"thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
|
||||
"processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
|
||||
"timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
|
||||
"partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
|
||||
# 100 * parts_processed / parts_total
|
||||
#
|
||||
# Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
|
||||
"partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
|
||||
},
|
||||
"tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
},
|
||||
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
|
||||
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
|
||||
},
|
||||
"etag": "A String", # The ETag of the video resource.
|
||||
"projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
|
||||
"tags": [ # A list of project tags associated with the video during the upload.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
|
||||
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"locationDescription": "A String", # The text description of the location where the video was recorded.
|
||||
@@ -178,15 +283,30 @@ Returns:
|
||||
|
||||
{ # A video resource represents a YouTube video.
|
||||
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
|
||||
"license": "A String", # The video's license.
|
||||
"embeddable": True or False, # This value indicates if the video can be embedded on another website.
|
||||
"privacyStatus": "A String", # The video's privacy status.
|
||||
"uploadStatus": "A String", # The status of the uploaded video.
|
||||
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
|
||||
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
|
||||
},
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"description": "A String", # The video's description.
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel that the video belongs to.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
|
||||
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
|
||||
@@ -196,9 +316,29 @@ Returns:
|
||||
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
|
||||
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
|
||||
},
|
||||
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
|
||||
"access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
},
|
||||
"contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
|
||||
"countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
"caption": "A String", # The value of captions indicates whether the video has captions or not.
|
||||
"regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
|
||||
"A String",
|
||||
],
|
||||
@@ -206,28 +346,97 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
|
||||
"dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
|
||||
},
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
},
|
||||
},
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
|
||||
"processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"description": "A String", # The video's description.
|
||||
"tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
|
||||
{ # A single tag suggestion with it's relevance information.
|
||||
"categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
|
||||
"A String",
|
||||
],
|
||||
"tag": "A String", # The keyword tag suggested for the video.
|
||||
},
|
||||
],
|
||||
"editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
|
||||
"A String",
|
||||
],
|
||||
"processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
|
||||
"A String",
|
||||
],
|
||||
"processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
|
||||
"bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
|
||||
"container": "A String", # The uploaded video file's container format.
|
||||
"recordingLocation": { # A geoPoint holds geo location information associated with a YouTube resource. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
|
||||
"latitude": 3.14, # Latitude in degrees.
|
||||
"elevation": 3.14, # Altitude above the Earth, in meters.
|
||||
"longitude": 3.14, # Longitude in degrees.
|
||||
},
|
||||
"fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
|
||||
"creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
|
||||
# - Date only: YYYY-MM-DD
|
||||
# - Naive time: YYYY-MM-DDTHH:MM:SS
|
||||
# - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
|
||||
"durationMs": "A String", # The length of the uploaded video in milliseconds.
|
||||
"fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
|
||||
"fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
|
||||
"videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
|
||||
{ # Information about a video stream.
|
||||
"bitrateBps": "A String", # The video stream's bitrate, in bits per second.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"codec": "A String", # The video codec that the stream uses.
|
||||
"widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
|
||||
"heightPixels": 42, # The encoded video content's height in pixels.
|
||||
"aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
|
||||
"rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
|
||||
"frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
|
||||
},
|
||||
],
|
||||
"audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
|
||||
{ # Information about an audio stream.
|
||||
"bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
|
||||
"codec": "A String", # The audio codec that the stream uses.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"channelCount": 42, # The number of audio channels that the stream contains.
|
||||
},
|
||||
],
|
||||
},
|
||||
"processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
|
||||
#
|
||||
# The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
|
||||
"fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
|
||||
"editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
|
||||
"processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
|
||||
"thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
|
||||
"processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
|
||||
"timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
|
||||
"partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
|
||||
# 100 * parts_processed / parts_total
|
||||
#
|
||||
# Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
|
||||
"partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
|
||||
},
|
||||
"tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
},
|
||||
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
|
||||
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
|
||||
},
|
||||
"etag": "A String", # The ETag of the video resource.
|
||||
"projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
|
||||
"tags": [ # A list of project tags associated with the video during the upload.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
|
||||
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"locationDescription": "A String", # The text description of the location where the video was recorded.
|
||||
@@ -242,7 +451,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(id, part=None)</code>
|
||||
<code class="details" id="list">list(id, part=None, onBehalfOfContentOwner=None)</code>
|
||||
<pre>Returns a list of videos that match the API request parameters.
|
||||
|
||||
Args:
|
||||
@@ -250,6 +459,7 @@ Args:
|
||||
part: string, The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails.
|
||||
|
||||
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. (required)
|
||||
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -258,15 +468,30 @@ Returns:
|
||||
"items": [ # A list of videos that match the request criteria.
|
||||
{ # A video resource represents a YouTube video.
|
||||
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
|
||||
"license": "A String", # The video's license.
|
||||
"embeddable": True or False, # This value indicates if the video can be embedded on another website.
|
||||
"privacyStatus": "A String", # The video's privacy status.
|
||||
"uploadStatus": "A String", # The status of the uploaded video.
|
||||
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
|
||||
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
|
||||
},
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"description": "A String", # The video's description.
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel that the video belongs to.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
|
||||
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
|
||||
@@ -276,9 +501,29 @@ Returns:
|
||||
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
|
||||
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
|
||||
},
|
||||
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
|
||||
"access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
},
|
||||
"contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
|
||||
"countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
"caption": "A String", # The value of captions indicates whether the video has captions or not.
|
||||
"regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
|
||||
"A String",
|
||||
],
|
||||
@@ -286,28 +531,97 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
|
||||
"dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
|
||||
},
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
},
|
||||
},
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
|
||||
"processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"description": "A String", # The video's description.
|
||||
"tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
|
||||
{ # A single tag suggestion with it's relevance information.
|
||||
"categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
|
||||
"A String",
|
||||
],
|
||||
"tag": "A String", # The keyword tag suggested for the video.
|
||||
},
|
||||
],
|
||||
"editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
|
||||
"A String",
|
||||
],
|
||||
"processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
|
||||
"A String",
|
||||
],
|
||||
"processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
|
||||
"bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
|
||||
"container": "A String", # The uploaded video file's container format.
|
||||
"recordingLocation": { # A geoPoint holds geo location information associated with a YouTube resource. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
|
||||
"latitude": 3.14, # Latitude in degrees.
|
||||
"elevation": 3.14, # Altitude above the Earth, in meters.
|
||||
"longitude": 3.14, # Longitude in degrees.
|
||||
},
|
||||
"fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
|
||||
"creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
|
||||
# - Date only: YYYY-MM-DD
|
||||
# - Naive time: YYYY-MM-DDTHH:MM:SS
|
||||
# - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
|
||||
"durationMs": "A String", # The length of the uploaded video in milliseconds.
|
||||
"fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
|
||||
"fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
|
||||
"videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
|
||||
{ # Information about a video stream.
|
||||
"bitrateBps": "A String", # The video stream's bitrate, in bits per second.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"codec": "A String", # The video codec that the stream uses.
|
||||
"widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
|
||||
"heightPixels": 42, # The encoded video content's height in pixels.
|
||||
"aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
|
||||
"rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
|
||||
"frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
|
||||
},
|
||||
],
|
||||
"audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
|
||||
{ # Information about an audio stream.
|
||||
"bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
|
||||
"codec": "A String", # The audio codec that the stream uses.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"channelCount": 42, # The number of audio channels that the stream contains.
|
||||
},
|
||||
],
|
||||
},
|
||||
"processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
|
||||
#
|
||||
# The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
|
||||
"fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
|
||||
"editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
|
||||
"processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
|
||||
"thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
|
||||
"processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
|
||||
"timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
|
||||
"partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
|
||||
# 100 * parts_processed / parts_total
|
||||
#
|
||||
# Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
|
||||
"partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
|
||||
},
|
||||
"tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
},
|
||||
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
|
||||
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
|
||||
},
|
||||
"etag": "A String", # The ETag of the video resource.
|
||||
"projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
|
||||
"tags": [ # A list of project tags associated with the video during the upload.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
|
||||
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"locationDescription": "A String", # The text description of the location where the video was recorded.
|
||||
@@ -326,7 +640,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(part=None, body)</code>
|
||||
<code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
|
||||
<pre>Updates a video's metadata.
|
||||
|
||||
Args:
|
||||
@@ -342,15 +656,30 @@ In addition, not all of those parts contain properties that can be set when sett
|
||||
|
||||
{ # A video resource represents a YouTube video.
|
||||
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
|
||||
"license": "A String", # The video's license.
|
||||
"embeddable": True or False, # This value indicates if the video can be embedded on another website.
|
||||
"privacyStatus": "A String", # The video's privacy status.
|
||||
"uploadStatus": "A String", # The status of the uploaded video.
|
||||
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
|
||||
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
|
||||
},
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"description": "A String", # The video's description.
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel that the video belongs to.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
|
||||
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
|
||||
@@ -360,9 +689,29 @@ In addition, not all of those parts contain properties that can be set when sett
|
||||
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
|
||||
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
|
||||
},
|
||||
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
|
||||
"access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
},
|
||||
"contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
|
||||
"countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
"caption": "A String", # The value of captions indicates whether the video has captions or not.
|
||||
"regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
|
||||
"A String",
|
||||
],
|
||||
@@ -370,28 +719,97 @@ In addition, not all of those parts contain properties that can be set when sett
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
|
||||
"dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
|
||||
},
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
},
|
||||
},
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
|
||||
"processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"description": "A String", # The video's description.
|
||||
"tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
|
||||
{ # A single tag suggestion with it's relevance information.
|
||||
"categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
|
||||
"A String",
|
||||
],
|
||||
"tag": "A String", # The keyword tag suggested for the video.
|
||||
},
|
||||
],
|
||||
"editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
|
||||
"A String",
|
||||
],
|
||||
"processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
|
||||
"A String",
|
||||
],
|
||||
"processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
|
||||
"bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
|
||||
"container": "A String", # The uploaded video file's container format.
|
||||
"recordingLocation": { # A geoPoint holds geo location information associated with a YouTube resource. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
|
||||
"latitude": 3.14, # Latitude in degrees.
|
||||
"elevation": 3.14, # Altitude above the Earth, in meters.
|
||||
"longitude": 3.14, # Longitude in degrees.
|
||||
},
|
||||
"fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
|
||||
"creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
|
||||
# - Date only: YYYY-MM-DD
|
||||
# - Naive time: YYYY-MM-DDTHH:MM:SS
|
||||
# - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
|
||||
"durationMs": "A String", # The length of the uploaded video in milliseconds.
|
||||
"fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
|
||||
"fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
|
||||
"videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
|
||||
{ # Information about a video stream.
|
||||
"bitrateBps": "A String", # The video stream's bitrate, in bits per second.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"codec": "A String", # The video codec that the stream uses.
|
||||
"widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
|
||||
"heightPixels": 42, # The encoded video content's height in pixels.
|
||||
"aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
|
||||
"rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
|
||||
"frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
|
||||
},
|
||||
],
|
||||
"audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
|
||||
{ # Information about an audio stream.
|
||||
"bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
|
||||
"codec": "A String", # The audio codec that the stream uses.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"channelCount": 42, # The number of audio channels that the stream contains.
|
||||
},
|
||||
],
|
||||
},
|
||||
"processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
|
||||
#
|
||||
# The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
|
||||
"fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
|
||||
"editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
|
||||
"processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
|
||||
"thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
|
||||
"processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
|
||||
"timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
|
||||
"partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
|
||||
# 100 * parts_processed / parts_total
|
||||
#
|
||||
# Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
|
||||
"partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
|
||||
},
|
||||
"tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
},
|
||||
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
|
||||
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
|
||||
},
|
||||
"etag": "A String", # The ETag of the video resource.
|
||||
"projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
|
||||
"tags": [ # A list of project tags associated with the video during the upload.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
|
||||
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"locationDescription": "A String", # The text description of the location where the video was recorded.
|
||||
@@ -404,21 +822,37 @@ In addition, not all of those parts contain properties that can be set when sett
|
||||
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
|
||||
}
|
||||
|
||||
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A video resource represents a YouTube video.
|
||||
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
|
||||
"license": "A String", # The video's license.
|
||||
"embeddable": True or False, # This value indicates if the video can be embedded on another website.
|
||||
"privacyStatus": "A String", # The video's privacy status.
|
||||
"uploadStatus": "A String", # The status of the uploaded video.
|
||||
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
|
||||
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
|
||||
},
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"description": "A String", # The video's description.
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"channelTitle": "A String", # Channel title for the channel that the video belongs to.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42, # (Optional) Width of the thumbnail image.
|
||||
"height": 42, # (Optional) Height of the thumbnail image.
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
|
||||
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
|
||||
@@ -428,9 +862,29 @@ Returns:
|
||||
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
|
||||
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
|
||||
},
|
||||
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
|
||||
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
|
||||
"access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
},
|
||||
"contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
|
||||
"definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
|
||||
"countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
|
||||
"exception": [ # A list of region codes that identify countries where the default policy do not apply.
|
||||
"A String",
|
||||
],
|
||||
"allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
|
||||
},
|
||||
"caption": "A String", # The value of captions indicates whether the video has captions or not.
|
||||
"regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
|
||||
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
|
||||
"A String",
|
||||
],
|
||||
@@ -438,28 +892,97 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
|
||||
"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
|
||||
"dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
|
||||
},
|
||||
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
|
||||
"thumbnails": { # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
|
||||
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
|
||||
"url": "A String", # The thumbnail image's URL.
|
||||
"width": 42,
|
||||
"height": 42,
|
||||
},
|
||||
},
|
||||
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
|
||||
"suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
|
||||
"processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
|
||||
"A String",
|
||||
],
|
||||
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
|
||||
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"title": "A String", # The video's title.
|
||||
"categoryId": "A String", # The YouTube video category associated with the video.
|
||||
"description": "A String", # The video's description.
|
||||
"tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
|
||||
{ # A single tag suggestion with it's relevance information.
|
||||
"categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
|
||||
"A String",
|
||||
],
|
||||
"tag": "A String", # The keyword tag suggested for the video.
|
||||
},
|
||||
],
|
||||
"editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
|
||||
"A String",
|
||||
],
|
||||
"processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
|
||||
"A String",
|
||||
],
|
||||
"processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
|
||||
"bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
|
||||
"container": "A String", # The uploaded video file's container format.
|
||||
"recordingLocation": { # A geoPoint holds geo location information associated with a YouTube resource. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
|
||||
"latitude": 3.14, # Latitude in degrees.
|
||||
"elevation": 3.14, # Altitude above the Earth, in meters.
|
||||
"longitude": 3.14, # Longitude in degrees.
|
||||
},
|
||||
"fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
|
||||
"creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
|
||||
# - Date only: YYYY-MM-DD
|
||||
# - Naive time: YYYY-MM-DDTHH:MM:SS
|
||||
# - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
|
||||
"durationMs": "A String", # The length of the uploaded video in milliseconds.
|
||||
"fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
|
||||
"fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
|
||||
"videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
|
||||
{ # Information about a video stream.
|
||||
"bitrateBps": "A String", # The video stream's bitrate, in bits per second.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"codec": "A String", # The video codec that the stream uses.
|
||||
"widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
|
||||
"heightPixels": 42, # The encoded video content's height in pixels.
|
||||
"aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
|
||||
"rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
|
||||
"frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
|
||||
},
|
||||
],
|
||||
"audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
|
||||
{ # Information about an audio stream.
|
||||
"bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
|
||||
"codec": "A String", # The audio codec that the stream uses.
|
||||
"vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
|
||||
"channelCount": 42, # The number of audio channels that the stream contains.
|
||||
},
|
||||
],
|
||||
},
|
||||
"processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
|
||||
#
|
||||
# The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
|
||||
"fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
|
||||
"editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
|
||||
"processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
"processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
|
||||
"thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
|
||||
"processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
|
||||
"timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
|
||||
"partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
|
||||
# 100 * parts_processed / parts_total
|
||||
#
|
||||
# Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
|
||||
"partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
|
||||
},
|
||||
"tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
|
||||
},
|
||||
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
|
||||
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
|
||||
},
|
||||
"etag": "A String", # The ETag of the video resource.
|
||||
"projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
|
||||
"tags": [ # A list of project tags associated with the video during the upload.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
|
||||
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
||||
"locationDescription": "A String", # The text description of the location where the video was recorded.
|
||||
|
||||
@@ -1,19 +1,26 @@
|
||||
apiclient apiclient-module.html
|
||||
apiclient.discovery apiclient.discovery-module.html
|
||||
apiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE apiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE
|
||||
apiclient.discovery._cast apiclient.discovery-module.html#_cast
|
||||
apiclient.discovery.MULTIPLIERS apiclient.discovery-module.html#MULTIPLIERS
|
||||
apiclient.discovery.fix_method_name apiclient.discovery-module.html#fix_method_name
|
||||
apiclient.discovery._MEDIA_SIZE_BIT_SHIFTS apiclient.discovery-module.html#_MEDIA_SIZE_BIT_SHIFTS
|
||||
apiclient.discovery._fix_up_parameters apiclient.discovery-module.html#_fix_up_parameters
|
||||
apiclient.discovery.HTTP_PAYLOAD_METHODS apiclient.discovery-module.html#HTTP_PAYLOAD_METHODS
|
||||
apiclient.discovery._media_path_url_from_info apiclient.discovery-module.html#_media_path_url_from_info
|
||||
apiclient.discovery._fix_up_media_upload apiclient.discovery-module.html#_fix_up_media_upload
|
||||
apiclient.discovery.build apiclient.discovery-module.html#build
|
||||
apiclient.discovery.key2param apiclient.discovery-module.html#key2param
|
||||
apiclient.discovery.VARNAME apiclient.discovery-module.html#VARNAME
|
||||
apiclient.discovery.createNextMethod apiclient.discovery-module.html#createNextMethod
|
||||
apiclient.discovery.logger apiclient.discovery-module.html#logger
|
||||
apiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE apiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE
|
||||
apiclient.discovery._media_size_to_long apiclient.discovery-module.html#_media_size_to_long
|
||||
apiclient.discovery._add_query_parameter apiclient.discovery-module.html#_add_query_parameter
|
||||
apiclient.discovery._fix_up_method_description apiclient.discovery-module.html#_fix_up_method_description
|
||||
apiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE apiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE
|
||||
apiclient.discovery.createMethod apiclient.discovery-module.html#createMethod
|
||||
apiclient.discovery.DEFAULT_METHOD_DOC apiclient.discovery-module.html#DEFAULT_METHOD_DOC
|
||||
apiclient.discovery.RESERVED_WORDS apiclient.discovery-module.html#RESERVED_WORDS
|
||||
apiclient.discovery.build_from_document apiclient.discovery-module.html#build_from_document
|
||||
apiclient.discovery.fix_method_name apiclient.discovery-module.html#fix_method_name
|
||||
apiclient.discovery.STACK_QUERY_PARAMETERS apiclient.discovery-module.html#STACK_QUERY_PARAMETERS
|
||||
apiclient.discovery.DISCOVERY_URI apiclient.discovery-module.html#DISCOVERY_URI
|
||||
apiclient.discovery.URITEMPLATE apiclient.discovery-module.html#URITEMPLATE
|
||||
@@ -49,6 +56,9 @@ apiclient.push.SUBSCRIPTION_ID apiclient.push-module.html#SUBSCRIPTION_ID
|
||||
apiclient.push.CLIENT_TOKEN apiclient.push-module.html#CLIENT_TOKEN
|
||||
apiclient.schema apiclient.schema-module.html
|
||||
oauth2client oauth2client-module.html
|
||||
oauth2client.GOOGLE_REVOKE_URI oauth2client-module.html#GOOGLE_REVOKE_URI
|
||||
oauth2client.GOOGLE_TOKEN_URI oauth2client-module.html#GOOGLE_TOKEN_URI
|
||||
oauth2client.GOOGLE_AUTH_URI oauth2client-module.html#GOOGLE_AUTH_URI
|
||||
oauth2client.anyjson oauth2client.anyjson-module.html
|
||||
oauth2client.appengine oauth2client.appengine-module.html
|
||||
oauth2client.appengine._safe_html oauth2client.appengine-module.html#_safe_html
|
||||
@@ -58,6 +68,7 @@ oauth2client.appengine.OAUTH2CLIENT_NAMESPACE oauth2client.appengine-module.html
|
||||
oauth2client.appengine.logger oauth2client.appengine-module.html#logger
|
||||
oauth2client.appengine._generate_new_xsrf_secret_key oauth2client.appengine-module.html#_generate_new_xsrf_secret_key
|
||||
oauth2client.appengine.xsrf_secret_key oauth2client.appengine-module.html#xsrf_secret_key
|
||||
oauth2client.appengine.ndb oauth2client.appengine-module.html#ndb
|
||||
oauth2client.appengine.oauth2decorator_from_clientsecrets oauth2client.appengine-module.html#oauth2decorator_from_clientsecrets
|
||||
oauth2client.appengine._parse_state_value oauth2client.appengine-module.html#_parse_state_value
|
||||
oauth2client.client oauth2client.client-module.html
|
||||
@@ -67,6 +78,7 @@ oauth2client.client._cached_http oauth2client.client-module.html#_cached_http
|
||||
oauth2client.client.ID_TOKEN_VERIFICATON_CERTS oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS
|
||||
oauth2client.client.credentials_from_clientsecrets_and_code oauth2client.client-module.html#credentials_from_clientsecrets_and_code
|
||||
oauth2client.client.flow_from_clientsecrets oauth2client.client-module.html#flow_from_clientsecrets
|
||||
oauth2client.client._update_query_params oauth2client.client-module.html#_update_query_params
|
||||
oauth2client.client.EXPIRY_FORMAT oauth2client.client-module.html#EXPIRY_FORMAT
|
||||
oauth2client.client.logger oauth2client.client-module.html#logger
|
||||
oauth2client.client._abstract oauth2client.client-module.html#_abstract
|
||||
@@ -74,8 +86,9 @@ oauth2client.client.clean_headers oauth2client.client-module.html#clean_headers
|
||||
oauth2client.client.OOB_CALLBACK_URN oauth2client.client-module.html#OOB_CALLBACK_URN
|
||||
oauth2client.client._parse_exchange_token_response oauth2client.client-module.html#_parse_exchange_token_response
|
||||
oauth2client.client.credentials_from_code oauth2client.client-module.html#credentials_from_code
|
||||
oauth2client.client._urlsafe_b64decode oauth2client.client-module.html#_urlsafe_b64decode
|
||||
oauth2client.client.HAS_OPENSSL oauth2client.client-module.html#HAS_OPENSSL
|
||||
oauth2client.client.verify_id_token oauth2client.client-module.html#verify_id_token
|
||||
oauth2client.client._urlsafe_b64decode oauth2client.client-module.html#_urlsafe_b64decode
|
||||
oauth2client.client.REFRESH_STATUS_CODES oauth2client.client-module.html#REFRESH_STATUS_CODES
|
||||
oauth2client.clientsecrets oauth2client.clientsecrets-module.html
|
||||
oauth2client.clientsecrets.load oauth2client.clientsecrets-module.html#load
|
||||
@@ -124,10 +137,11 @@ oauth2client.tools oauth2client.tools-module.html
|
||||
oauth2client.tools.run oauth2client.tools-module.html#run
|
||||
oauth2client.tools.FLAGS oauth2client.tools-module.html#FLAGS
|
||||
oauth2client.util oauth2client.util-module.html
|
||||
oauth2client.util.scopes_to_string oauth2client.util-module.html#scopes_to_string
|
||||
oauth2client.util.dict_to_tuple_key oauth2client.util-module.html#dict_to_tuple_key
|
||||
oauth2client.util.positional oauth2client.util-module.html#positional
|
||||
oauth2client.util.scopes_to_string oauth2client.util-module.html#scopes_to_string
|
||||
oauth2client.util.FLAGS oauth2client.util-module.html#FLAGS
|
||||
oauth2client.util.dict_to_tuple_key oauth2client.util-module.html#dict_to_tuple_key
|
||||
oauth2client.util._add_query_parameter oauth2client.util-module.html#_add_query_parameter
|
||||
oauth2client.util.logger oauth2client.util-module.html#logger
|
||||
oauth2client.xsrfutil oauth2client.xsrfutil-module.html
|
||||
oauth2client.xsrfutil.validate_token oauth2client.xsrfutil-module.html#validate_token
|
||||
@@ -143,6 +157,9 @@ apiclient.discovery.Resource.__init__ apiclient.discovery.Resource-class.html#__
|
||||
apiclient.discovery.Resource._set_service_methods apiclient.discovery.Resource-class.html#_set_service_methods
|
||||
apiclient.discovery.Resource.__getstate__ apiclient.discovery.Resource-class.html#__getstate__
|
||||
apiclient.discovery.Resource._add_basic_methods apiclient.discovery.Resource-class.html#_add_basic_methods
|
||||
apiclient.discovery.ResourceMethodParameters apiclient.discovery.ResourceMethodParameters-class.html
|
||||
apiclient.discovery.ResourceMethodParameters.set_parameters apiclient.discovery.ResourceMethodParameters-class.html#set_parameters
|
||||
apiclient.discovery.ResourceMethodParameters.__init__ apiclient.discovery.ResourceMethodParameters-class.html#__init__
|
||||
apiclient.errors.BatchError apiclient.errors.BatchError-class.html
|
||||
apiclient.errors.BatchError.__str__ apiclient.errors.BatchError-class.html#__str__
|
||||
apiclient.errors.BatchError.__repr__ apiclient.errors.BatchError-class.html#__repr__
|
||||
@@ -158,6 +175,10 @@ apiclient.errors.InvalidChunkSizeError apiclient.errors.InvalidChunkSizeError-cl
|
||||
apiclient.errors.InvalidJsonError apiclient.errors.InvalidJsonError-class.html
|
||||
apiclient.errors.MediaUploadSizeError apiclient.errors.MediaUploadSizeError-class.html
|
||||
apiclient.errors.ResumableUploadError apiclient.errors.ResumableUploadError-class.html
|
||||
apiclient.errors.HttpError.__str__ apiclient.errors.HttpError-class.html#__str__
|
||||
apiclient.errors.HttpError.__repr__ apiclient.errors.HttpError-class.html#__repr__
|
||||
apiclient.errors.HttpError.__init__ apiclient.errors.HttpError-class.html#__init__
|
||||
apiclient.errors.HttpError._get_reason apiclient.errors.HttpError-class.html#_get_reason
|
||||
apiclient.errors.UnacceptableMimeTypeError apiclient.errors.UnacceptableMimeTypeError-class.html
|
||||
apiclient.errors.UnexpectedBodyError apiclient.errors.UnexpectedBodyError-class.html
|
||||
apiclient.errors.UnexpectedBodyError.__init__ apiclient.errors.UnexpectedBodyError-class.html#__init__
|
||||
@@ -370,27 +391,33 @@ apiclient.schema._SchemaToStruct.emitBegin apiclient.schema._SchemaToStruct-clas
|
||||
apiclient.schema._SchemaToStruct.undent apiclient.schema._SchemaToStruct-class.html#undent
|
||||
apiclient.schema._SchemaToStruct.emit apiclient.schema._SchemaToStruct-class.html#emit
|
||||
apiclient.schema._SchemaToStruct.__init__ apiclient.schema._SchemaToStruct-class.html#__init__
|
||||
google.appengine.ext.db.PropertiedClass google.appengine.ext.db.PropertiedClass-class.html
|
||||
google.appengine.ext.db.PropertiedClass.__init__ google.appengine.ext.db.PropertiedClass-class.html#__init__
|
||||
oauth2client.appengine.AppAssertionCredentials oauth2client.appengine.AppAssertionCredentials-class.html
|
||||
oauth2client.appengine.AppAssertionCredentials.from_json oauth2client.appengine.AppAssertionCredentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.appengine.AppAssertionCredentials.__init__ oauth2client.appengine.AppAssertionCredentials-class.html#__init__
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.appengine.AppAssertionCredentials._refresh oauth2client.appengine.AppAssertionCredentials-class.html#_refresh
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.AssertionCredentials._revoke oauth2client.client.AssertionCredentials-class.html#_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_assertion oauth2client.client.AssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_refresh_request_body oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
oauth2client.client.OAuth2Credentials.access_token_expired oauth2client.client.OAuth2Credentials-class.html#access_token_expired
|
||||
oauth2client.appengine.CredentialsModel oauth2client.appengine.CredentialsModel-class.html
|
||||
google.appengine.ext.db.Model.__metaclass__ google.appengine.ext.db.PropertiedClass-class.html
|
||||
oauth2client.appengine.CredentialsModel.credentials oauth2client.appengine.CredentialsModel-class.html#credentials
|
||||
oauth2client.appengine.CredentialsNDBModel oauth2client.appengine.CredentialsNDBModel-class.html
|
||||
oauth2client.appengine.CredentialsNDBModel.credentials oauth2client.appengine.CredentialsNDBModel-class.html#credentials
|
||||
@@ -401,17 +428,17 @@ oauth2client.appengine.CredentialsNDBProperty._from_base_type oauth2client.appen
|
||||
oauth2client.appengine.CredentialsNDBProperty._to_base_type oauth2client.appengine.CredentialsNDBProperty-class.html#_to_base_type
|
||||
oauth2client.appengine.CredentialsProperty oauth2client.appengine.CredentialsProperty-class.html
|
||||
oauth2client.appengine.CredentialsProperty.make_value_from_datastore oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore
|
||||
oauth2client.appengine.CredentialsProperty.data_type oauth2client.appengine.CredentialsProperty-class.html#data_type
|
||||
oauth2client.appengine.CredentialsProperty.validate oauth2client.appengine.CredentialsProperty-class.html#validate
|
||||
oauth2client.appengine.CredentialsProperty.get_value_for_datastore oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore
|
||||
oauth2client.appengine.CredentialsProperty.data_type oauth2client.appengine.CredentialsProperty-class.html#data_type
|
||||
oauth2client.appengine.FlowNDBProperty oauth2client.appengine.FlowNDBProperty-class.html
|
||||
oauth2client.appengine.FlowNDBProperty._validate oauth2client.appengine.FlowNDBProperty-class.html#_validate
|
||||
oauth2client.appengine.FlowProperty oauth2client.appengine.FlowProperty-class.html
|
||||
oauth2client.appengine.FlowProperty.make_value_from_datastore oauth2client.appengine.FlowProperty-class.html#make_value_from_datastore
|
||||
oauth2client.appengine.FlowProperty.validate oauth2client.appengine.FlowProperty-class.html#validate
|
||||
oauth2client.appengine.FlowProperty.get_value_for_datastore oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore
|
||||
oauth2client.appengine.FlowProperty.empty oauth2client.appengine.FlowProperty-class.html#empty
|
||||
oauth2client.appengine.FlowProperty.data_type oauth2client.appengine.FlowProperty-class.html#data_type
|
||||
oauth2client.appengine.FlowProperty.validate oauth2client.appengine.FlowProperty-class.html#validate
|
||||
oauth2client.appengine.FlowProperty.empty oauth2client.appengine.FlowProperty-class.html#empty
|
||||
oauth2client.appengine.FlowProperty.get_value_for_datastore oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore
|
||||
oauth2client.appengine.InvalidClientSecretsError oauth2client.appengine.InvalidClientSecretsError-class.html
|
||||
oauth2client.appengine.InvalidXsrfTokenError oauth2client.appengine.InvalidXsrfTokenError-class.html
|
||||
oauth2client.appengine.OAuth2Decorator oauth2client.appengine.OAuth2Decorator-class.html
|
||||
@@ -439,6 +466,7 @@ oauth2client.appengine.OAuth2Decorator.oauth_aware oauth2client.appengine.OAuth2
|
||||
oauth2client.appengine.OAuth2Decorator.callback_path oauth2client.appengine.OAuth2Decorator-class.html#callback_path
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_required oauth2client.appengine.OAuth2Decorator-class.html#oauth_required
|
||||
oauth2client.appengine.SiteXsrfSecretKey oauth2client.appengine.SiteXsrfSecretKey-class.html
|
||||
google.appengine.ext.db.Model.__metaclass__ google.appengine.ext.db.PropertiedClass-class.html
|
||||
oauth2client.appengine.SiteXsrfSecretKey.secret oauth2client.appengine.SiteXsrfSecretKey-class.html#secret
|
||||
oauth2client.appengine.SiteXsrfSecretKeyNDB oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html
|
||||
oauth2client.appengine.SiteXsrfSecretKeyNDB.secret oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html#secret
|
||||
@@ -459,18 +487,21 @@ oauth2client.client.Storage.delete oauth2client.client.Storage-class.html#delete
|
||||
oauth2client.client.AccessTokenCredentials oauth2client.client.AccessTokenCredentials-class.html
|
||||
oauth2client.client.AccessTokenCredentials.from_json oauth2client.client.AccessTokenCredentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.client.AccessTokenCredentials.__init__ oauth2client.client.AccessTokenCredentials-class.html#__init__
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.client.AccessTokenCredentials._refresh oauth2client.client.AccessTokenCredentials-class.html#_refresh
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.AccessTokenCredentials._revoke oauth2client.client.AccessTokenCredentials-class.html#_revoke
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_body oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
@@ -480,19 +511,22 @@ oauth2client.client.AccessTokenRefreshError oauth2client.client.AccessTokenRefre
|
||||
oauth2client.client.AssertionCredentials oauth2client.client.AssertionCredentials-class.html
|
||||
oauth2client.client.OAuth2Credentials.from_json oauth2client.client.OAuth2Credentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.client.AssertionCredentials.__init__ oauth2client.client.AssertionCredentials-class.html#__init__
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.client.OAuth2Credentials._refresh oauth2client.client.OAuth2Credentials-class.html#_refresh
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.AssertionCredentials._revoke oauth2client.client.AssertionCredentials-class.html#_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_assertion oauth2client.client.AssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_refresh_request_body oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
@@ -500,6 +534,7 @@ oauth2client.client.OAuth2Credentials.access_token_expired oauth2client.client.O
|
||||
oauth2client.client.Credentials oauth2client.client.Credentials-class.html
|
||||
oauth2client.client.Credentials.authorize oauth2client.client.Credentials-class.html#authorize
|
||||
oauth2client.client.Credentials.from_json oauth2client.client.Credentials-class.html#from_json
|
||||
oauth2client.client.Credentials.revoke oauth2client.client.Credentials-class.html#revoke
|
||||
oauth2client.client.Credentials.to_json oauth2client.client.Credentials-class.html#to_json
|
||||
oauth2client.client.Credentials.apply oauth2client.client.Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
@@ -518,18 +553,21 @@ oauth2client.client.NonAsciiHeaderError oauth2client.client.NonAsciiHeaderError-
|
||||
oauth2client.client.OAuth2Credentials oauth2client.client.OAuth2Credentials-class.html
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.from_json oauth2client.client.OAuth2Credentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.client.OAuth2Credentials.__init__ oauth2client.client.OAuth2Credentials-class.html#__init__
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.client.OAuth2Credentials._refresh oauth2client.client.OAuth2Credentials-class.html#_refresh
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.OAuth2Credentials._revoke oauth2client.client.OAuth2Credentials-class.html#_revoke
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_body oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
@@ -541,6 +579,7 @@ oauth2client.client.OAuth2WebServerFlow.__init__ oauth2client.client.OAuth2WebSe
|
||||
oauth2client.client.SignedJwtAssertionCredentials oauth2client.client.SignedJwtAssertionCredentials-class.html
|
||||
oauth2client.client.SignedJwtAssertionCredentials.from_json oauth2client.client.SignedJwtAssertionCredentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
@@ -549,11 +588,13 @@ oauth2client.client.SignedJwtAssertionCredentials.__init__ oauth2client.client.S
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.SignedJwtAssertionCredentials.MAX_TOKEN_LIFETIME_SECS oauth2client.client.SignedJwtAssertionCredentials-class.html#MAX_TOKEN_LIFETIME_SECS
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.SignedJwtAssertionCredentials._generate_assertion oauth2client.client.SignedJwtAssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.client.OAuth2Credentials._refresh oauth2client.client.OAuth2Credentials-class.html#_refresh
|
||||
oauth2client.client.SignedJwtAssertionCredentials._generate_assertion oauth2client.client.SignedJwtAssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.AssertionCredentials._revoke oauth2client.client.AssertionCredentials-class.html#_revoke
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_refresh_request_body oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
@@ -568,6 +609,7 @@ oauth2client.client.Storage.get oauth2client.client.Storage-class.html#get
|
||||
oauth2client.client.Storage.put oauth2client.client.Storage-class.html#put
|
||||
oauth2client.client.Storage.release_lock oauth2client.client.Storage-class.html#release_lock
|
||||
oauth2client.client.Storage.delete oauth2client.client.Storage-class.html#delete
|
||||
oauth2client.client.TokenRevokeError oauth2client.client.TokenRevokeError-class.html
|
||||
oauth2client.client.UnknownClientSecretsFlowError oauth2client.client.UnknownClientSecretsFlowError-class.html
|
||||
oauth2client.client.VerifyJwtTokenError oauth2client.client.VerifyJwtTokenError-class.html
|
||||
oauth2client.clientsecrets.Error oauth2client.clientsecrets.Error-class.html
|
||||
@@ -611,19 +653,22 @@ oauth2client.client.Storage.delete oauth2client.client.Storage-class.html#delete
|
||||
oauth2client.gce.AppAssertionCredentials oauth2client.gce.AppAssertionCredentials-class.html
|
||||
oauth2client.gce.AppAssertionCredentials.from_json oauth2client.gce.AppAssertionCredentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.revoke oauth2client.client.OAuth2Credentials-class.html#revoke
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.gce.AppAssertionCredentials.__init__ oauth2client.gce.AppAssertionCredentials-class.html#__init__
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.gce.AppAssertionCredentials._refresh oauth2client.gce.AppAssertionCredentials-class.html#_refresh
|
||||
oauth2client.client.AssertionCredentials._revoke oauth2client.client.AssertionCredentials-class.html#_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_assertion oauth2client.client.AssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.OAuth2Credentials._do_revoke oauth2client.client.OAuth2Credentials-class.html#_do_revoke
|
||||
oauth2client.client.AssertionCredentials._generate_refresh_request_body oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
|
||||
@@ -54,7 +54,7 @@
|
||||
<h1 class="epydoc">Package apiclient</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient-pysrc.html">source code</a></span></p>
|
||||
<hr />
|
||||
<div class="fields"> <p><strong>Version:</strong>
|
||||
1.0
|
||||
1.1
|
||||
</p>
|
||||
</div><!-- ==================== SUBMODULES ==================== -->
|
||||
<a name="section-Submodules"></a>
|
||||
@@ -75,7 +75,7 @@
|
||||
</tr>
|
||||
<tr><td class="summary">
|
||||
<ul class="nomargin">
|
||||
<li> <strong class="uidlink"><a href="apiclient.discovery-module.html">apiclient.discovery</a></strong>: <em class="summary">Client for discovery based APIs</em> </li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.discovery-module.html">apiclient.discovery</a></strong>: <em class="summary">Client for discovery based APIs.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.errors-module.html">apiclient.errors</a></strong>: <em class="summary">Errors for the library.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.ext-module.html">apiclient.ext</a></strong> </li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http-module.html">apiclient.http</a></strong>: <em class="summary">Classes to encapsulate a single HTTP request.</em> </li>
|
||||
@@ -110,7 +110,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:30 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:22 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
</table>
|
||||
<h1 class="epydoc">Source Code for <a href="apiclient-module.html">Package apiclient</a></h1>
|
||||
<pre class="py-src">
|
||||
<a name="L1"></a><tt class="py-lineno">1</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-docstring">"1.0"</tt> </tt>
|
||||
<a name="L1"></a><tt class="py-lineno">1</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-docstring">"1.1"</tt> </tt>
|
||||
<a name="L2"></a><tt class="py-lineno">2</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
||||
<!--
|
||||
expandto(location.href);
|
||||
@@ -83,7 +83,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:47 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -54,7 +54,7 @@
|
||||
<!-- ==================== MODULE DESCRIPTION ==================== -->
|
||||
<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html">source code</a></span></p>
|
||||
<pre class="literalblock">
|
||||
Client for discovery based APIs
|
||||
Client for discovery based APIs.
|
||||
|
||||
A client library for Google's discovery based APIs.
|
||||
|
||||
@@ -81,11 +81,19 @@ A client library for Google's discovery based APIs.
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery.Resource-class.html" class="summary-name">Resource</a><br />
|
||||
<a href="apiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br />
|
||||
Represents the parameters associated with a method.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br />
|
||||
A class for interacting with a resource.
|
||||
</td>
|
||||
</tr>
|
||||
@@ -122,25 +130,6 @@ A client library for Google's discovery based APIs.
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#_add_query_parameter" class="summary-sig-name" onclick="show_private();">_add_query_parameter</a>(<span class="summary-sig-arg">url</span>,
|
||||
<span class="summary-sig-arg">name</span>,
|
||||
<span class="summary-sig-arg">value</span>)</span><br />
|
||||
Adds a query parameter to a url.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -241,13 +230,88 @@ A client library for Google's discovery based APIs.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#createMethod" class="summary-sig-name">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#_media_path_url_from_info" class="summary-sig-name" onclick="show_private();">_media_path_url_from_info</a>(<span class="summary-sig-arg">root_desc</span>,
|
||||
<span class="summary-sig-arg">path_url</span>)</span><br />
|
||||
Creates an absolute media path URL.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_path_url_from_info">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#_fix_up_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>,
|
||||
<span class="summary-sig-arg">root_desc</span>,
|
||||
<span class="summary-sig-arg">http_method</span>)</span><br />
|
||||
Updates parameters of an API method with values specific to this library.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_parameters">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#_fix_up_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>,
|
||||
<span class="summary-sig-arg">root_desc</span>,
|
||||
<span class="summary-sig-arg">path_url</span>,
|
||||
<span class="summary-sig-arg">parameters</span>)</span><br />
|
||||
Updates parameters of API by adding 'media_body' if supported by method.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_media_upload">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#_fix_up_method_description" class="summary-sig-name" onclick="show_private();">_fix_up_method_description</a>(<span class="summary-sig-arg">method_desc</span>,
|
||||
<span class="summary-sig-arg">root_desc</span>)</span><br />
|
||||
Updates a method description in a discovery document.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_method_description">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#createMethod" class="summary-sig-name" onclick="show_private();">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
|
||||
<span class="summary-sig-arg">methodDesc</span>,
|
||||
<span class="summary-sig-arg">rootDesc</span>,
|
||||
<span class="summary-sig-arg">schema</span>)</span><br />
|
||||
@@ -261,13 +325,13 @@ A client library for Google's discovery based APIs.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#createNextMethod" class="summary-sig-name">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#createNextMethod" class="summary-sig-name" onclick="show_private();">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
|
||||
Creates any _next methods for attaching to a Resource.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#createNextMethod">source code</a></span>
|
||||
@@ -296,260 +360,91 @@ A client library for Google's discovery based APIs.
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="copy"></a><span class="summary-name">copy</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="httplib2"></a><span class="summary-name">httplib2</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="logging"></a><span class="summary-name">logging</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="os"></a><span class="summary-name">os</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="re"></a><span class="summary-name">re</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="uritemplate"></a><span class="summary-name">uritemplate</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="urllib"></a><span class="summary-name">urllib</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="urlparse"></a><span class="summary-name">urlparse</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="mimeparse"></a><span class="summary-name">mimeparse</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="mimetypes"></a><span class="summary-name">mimetypes</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="parse_qsl"></a><span class="summary-name">parse_qsl</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="HttpError"></a><span class="summary-name">HttpError</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="InvalidJsonError"></a><span class="summary-name">InvalidJsonError</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MediaUploadSizeError"></a><span class="summary-name">MediaUploadSizeError</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="UnacceptableMimeTypeError"></a><span class="summary-name">UnacceptableMimeTypeError</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="UnknownApiNameOrVersion"></a><span class="summary-name">UnknownApiNameOrVersion</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="UnknownFileType"></a><span class="summary-name">UnknownFileType</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="HttpRequest"></a><span class="summary-name">HttpRequest</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MediaFileUpload"></a><span class="summary-name">MediaFileUpload</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MediaUpload"></a><span class="summary-name">MediaUpload</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="JsonModel"></a><span class="summary-name">JsonModel</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MediaModel"></a><span class="summary-name">MediaModel</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="RawModel"></a><span class="summary-name">RawModel</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="Schemas"></a><span class="summary-name">Schemas</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MIMEMultipart"></a><span class="summary-name">MIMEMultipart</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MIMENonMultipart"></a><span class="summary-name">MIMENonMultipart</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="positional"></a><span class="summary-name">positional</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="simplejson"></a><span class="summary-name">simplejson</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
|
||||
<a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
|
||||
st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']">['trace', 'pp', 'userip', 'strict']</code>
|
||||
<a name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name">RESERVED_WORDS</a> = <code title="['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', \
|
||||
'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i\
|
||||
mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '\
|
||||
return', 'try', 'while', 'body']">['and', 'assert', 'break', 'class', 'continue<code class="variable-ellipsis">...</code></code>
|
||||
<a name="_MEDIA_SIZE_BIT_SHIFTS"></a><span class="summary-name">_MEDIA_SIZE_BIT_SHIFTS</span> = <code title="{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}">{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#MULTIPLIERS" class="summary-name">MULTIPLIERS</a> = <code title="{"KB": 2** 10, "MB": 2** 20, "GB": 2** 30, "TB": 2** 40,}">{"KB": 2** 10, "MB": 2** 20, "GB": 2** 30, "TB":<code class="variable-ellipsis">...</code></code>
|
||||
<a href="apiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description': 'The request body.', 'type': 'object', 'required': Tru\
|
||||
e,}">{'description': 'The request bo<code class="variable-ellipsis">...</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The filename of the media request body, or an instanc\
|
||||
e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(['trace', 'pp', 'userip', 'strict'])">frozenset(['trace', 'pp', 'userip', '<code class="variable-ellipsis">...</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'type': 'string', 'location': 'query'}">{'type': 'string', 'loca<code class="variable-ellipsis">...</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -594,40 +489,6 @@ Args:
|
||||
Returns:
|
||||
The name with a '_' prefixed if the name is a reserved word.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_add_query_parameter"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>,
|
||||
<span class="sig-arg">name</span>,
|
||||
<span class="sig-arg">value</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Adds a query parameter to a url.
|
||||
|
||||
Replaces the current value if it already exists in the URL.
|
||||
|
||||
Args:
|
||||
url: string, url to add the query parameter to.
|
||||
name: string, query parameter name.
|
||||
value: string, query parameter value.
|
||||
|
||||
Returns:
|
||||
Updated query parameter. Does not update the url if value is None.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
@@ -826,13 +687,194 @@ Args:
|
||||
Returns:
|
||||
The size as an integer value.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_media_path_url_from_info"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
|
||||
<span class="sig-arg">path_url</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_path_url_from_info">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Creates an absolute media path URL.
|
||||
|
||||
Constructed using the API root URI and service path from the discovery
|
||||
document and the relative path for the API method.
|
||||
|
||||
Args:
|
||||
root_desc: Dictionary; the entire original deserialized discovery document.
|
||||
path_url: String; the relative URL for the API method. Relative to the API
|
||||
root, which is specified in the discovery document.
|
||||
|
||||
Returns:
|
||||
String; the absolute URI for media upload for the API method.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_fix_up_parameters"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
|
||||
<span class="sig-arg">root_desc</span>,
|
||||
<span class="sig-arg">http_method</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_parameters">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Updates parameters of an API method with values specific to this library.
|
||||
|
||||
Specifically, adds whatever global parameters are specified by the API to the
|
||||
parameters for the individual method. Also adds parameters which don't
|
||||
appear in the discovery document, but are available to all discovery based
|
||||
APIs (these are listed in STACK_QUERY_PARAMETERS).
|
||||
|
||||
SIDE EFFECTS: This updates the parameters dictionary object in the method
|
||||
description.
|
||||
|
||||
Args:
|
||||
method_desc: Dictionary with metadata describing an API method. Value comes
|
||||
from the dictionary of methods stored in the 'methods' key in the
|
||||
deserialized discovery document.
|
||||
root_desc: Dictionary; the entire original deserialized discovery document.
|
||||
http_method: String; the HTTP method used to call the API method described
|
||||
in method_desc.
|
||||
|
||||
Returns:
|
||||
The updated Dictionary stored in the 'parameters' key of the method
|
||||
description dictionary.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_fix_up_media_upload"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
|
||||
<span class="sig-arg">root_desc</span>,
|
||||
<span class="sig-arg">path_url</span>,
|
||||
<span class="sig-arg">parameters</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_media_upload">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Updates parameters of API by adding 'media_body' if supported by method.
|
||||
|
||||
SIDE EFFECTS: If the method supports media upload and has a required body,
|
||||
sets body to be optional (required=False) instead. Also, if there is a
|
||||
'mediaUpload' in the method description, adds 'media_upload' key to
|
||||
parameters.
|
||||
|
||||
Args:
|
||||
method_desc: Dictionary with metadata describing an API method. Value comes
|
||||
from the dictionary of methods stored in the 'methods' key in the
|
||||
deserialized discovery document.
|
||||
root_desc: Dictionary; the entire original deserialized discovery document.
|
||||
path_url: String; the relative URL for the API method. Relative to the API
|
||||
root, which is specified in the discovery document.
|
||||
parameters: A dictionary describing method parameters for method described
|
||||
in method_desc.
|
||||
|
||||
Returns:
|
||||
Triple (accept, max_size, media_path_url) where:
|
||||
- accept is a list of strings representing what content types are
|
||||
accepted for media upload. Defaults to empty list if not in the
|
||||
discovery document.
|
||||
- max_size is a long representing the max size in bytes allowed for a
|
||||
media upload. Defaults to 0L if not in the discovery document.
|
||||
- media_path_url is a String; the absolute URI for media upload for the
|
||||
API method. Constructed using the API root URI and service path from
|
||||
the discovery document and the relative path for the API method. If
|
||||
media upload is not supported, this is None.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_fix_up_method_description"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>,
|
||||
<span class="sig-arg">root_desc</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_up_method_description">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Updates a method description in a discovery document.
|
||||
|
||||
SIDE EFFECTS: Changes the parameters dictionary in the method description with
|
||||
extra parameters which are used locally.
|
||||
|
||||
Args:
|
||||
method_desc: Dictionary with metadata describing an API method. Value comes
|
||||
from the dictionary of methods stored in the 'methods' key in the
|
||||
deserialized discovery document.
|
||||
root_desc: Dictionary; the entire original deserialized discovery document.
|
||||
|
||||
Returns:
|
||||
Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
|
||||
where:
|
||||
- path_url is a String; the relative URL for the API method. Relative to
|
||||
the API root, which is specified in the discovery document.
|
||||
- http_method is a String; the HTTP method used to call the API method
|
||||
described in the method description.
|
||||
- method_id is a String; the name of the RPC method associated with the
|
||||
API method, and is in the method description in the 'id' key.
|
||||
- accept is a list of strings representing what content types are
|
||||
accepted for media upload. Defaults to empty list if not in the
|
||||
discovery document.
|
||||
- max_size is a long representing the max size in bytes allowed for a
|
||||
media upload. Defaults to 0L if not in the discovery document.
|
||||
- media_path_url is a String; the absolute URI for media upload for the
|
||||
API method. Constructed using the API root URI and service path from
|
||||
the discovery document and the relative path for the API method. If
|
||||
media upload is not supported, this is None.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="createMethod"></a>
|
||||
<div>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
@@ -864,7 +906,7 @@ Args:
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="createNextMethod"></a>
|
||||
<div>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
@@ -910,7 +952,7 @@ Args:
|
||||
</tr>
|
||||
</table>
|
||||
<a name="DISCOVERY_URI"></a>
|
||||
<div>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
@@ -928,40 +970,75 @@ st'
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="RESERVED_WORDS"></a>
|
||||
<div>
|
||||
<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<h3 class="epydoc">RESERVED_WORDS</h3>
|
||||
<h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
|
||||
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
<dl class="fields">
|
||||
<dt>Value:</dt>
|
||||
<dd><table><tr><td><pre class="variable">
|
||||
['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
|
||||
'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
|
||||
mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
|
||||
return', 'try', 'while', 'body']
|
||||
{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
|
||||
e,}
|
||||
</pre></td></tr></table>
|
||||
</dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="MULTIPLIERS"></a>
|
||||
<div>
|
||||
<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<h3 class="epydoc">MULTIPLIERS</h3>
|
||||
<h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
|
||||
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
<dl class="fields">
|
||||
<dt>Value:</dt>
|
||||
<dd><table><tr><td><pre class="variable">
|
||||
{"KB": 2** 10, "MB": 2** 20, "GB": 2** 30, "TB": 2** 40,}
|
||||
{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
|
||||
e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}
|
||||
</pre></td></tr></table>
|
||||
</dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="STACK_QUERY_PARAMETERS"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
|
||||
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
<dl class="fields">
|
||||
<dt>Value:</dt>
|
||||
<dd><table><tr><td><pre class="variable">
|
||||
frozenset(['trace', 'pp', 'userip', 'strict'])
|
||||
</pre></td></tr></table>
|
||||
</dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
|
||||
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
<dl class="fields">
|
||||
<dt>Value:</dt>
|
||||
<dd><table><tr><td><pre class="variable">
|
||||
{'type': 'string', 'location': 'query'}
|
||||
</pre></td></tr></table>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -991,7 +1068,7 @@ return', 'try', 'while', 'body']
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -449,7 +449,7 @@ will be wiped and restored on pickle serialization.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:32 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -210,7 +210,7 @@ should be defined in this file.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -329,7 +329,7 @@ str(x)
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:32 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -166,7 +166,7 @@ Base error for this module.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:32 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -342,7 +342,7 @@ str(x)
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:32 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ The given chunksize is not valid.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:32 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ The JSON returned could not be parsed.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ Media is larger than the method can accept.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -57,9 +57,10 @@
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_resumableu" name="class_hierarchy_for_resumableu">
|
||||
<area shape="rect" id="node1" href="apiclient.errors.Error-class.html" title="Error" alt="" coords="68,123,119,151"/>
|
||||
<area shape="rect" id="node2" href="apiclient.errors.ResumableUploadError-class.html" title="ResumableUploadError" alt="" coords="205,6,363,34"/>
|
||||
<area shape="rect" id="node3" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="5,6,181,34"/>
|
||||
<area shape="rect" id="node4" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="20,65,167,93"/>
|
||||
<area shape="rect" id="node2" href="apiclient.errors.HttpError-class.html" title="HttpError" alt="" coords="205,6,280,34"/>
|
||||
<area shape="rect" id="node3" href="apiclient.errors.ResumableUploadError-class.html" title="ResumableUploadError" alt="" coords="304,6,461,34"/>
|
||||
<area shape="rect" id="node4" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="5,6,181,34"/>
|
||||
<area shape="rect" id="node5" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="20,65,167,93"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_resumableu.gif" alt='' usemap="#class_hierarchy_for_resumableu" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
@@ -89,8 +90,15 @@ Error occured during resumable upload.
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.errors.HttpError-class.html">HttpError</a></code></b>:
|
||||
<code><a href="apiclient.errors.HttpError-class.html#__init__">__init__</a></code>,
|
||||
<code><a href="apiclient.errors.HttpError-class.html#__repr__">__repr__</a></code>,
|
||||
<code><a href="apiclient.errors.HttpError-class.html#__str__">__str__</a></code>
|
||||
</p>
|
||||
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.errors.HttpError-class.html">HttpError</a></code></b> (private):
|
||||
<code><a href="apiclient.errors.HttpError-class.html#_get_reason" onclick="show_private();">_get_reason</a></code>
|
||||
</p></div>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception</code></b>:
|
||||
<code>__init__</code>,
|
||||
<code>__new__</code>
|
||||
</p>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
|
||||
@@ -99,10 +107,8 @@ Error occured during resumable upload.
|
||||
<code>__getitem__</code>,
|
||||
<code>__getslice__</code>,
|
||||
<code>__reduce__</code>,
|
||||
<code>__repr__</code>,
|
||||
<code>__setattr__</code>,
|
||||
<code>__setstate__</code>,
|
||||
<code>__str__</code>,
|
||||
<code>__unicode__</code>
|
||||
</p>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
||||
@@ -167,7 +173,7 @@ Error occured during resumable upload.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ That is an unacceptable mimetype for this operation.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -232,7 +232,7 @@ Constructor for an UnexpectedMethodError.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -234,7 +234,7 @@ Constructor for an UnexpectedMethodError.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ No API with that name and version exists.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:33 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ File type unknown or unexpected.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ Link type unknown or unexpected.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -84,7 +84,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:47 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -399,7 +399,7 @@ will result in a different signature.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -731,7 +731,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -242,7 +242,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -259,7 +259,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -533,7 +533,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:34 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -271,7 +271,7 @@ mocked and not really from an HTTP request/response.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -264,7 +264,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -375,7 +375,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -281,7 +281,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -294,7 +294,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -658,7 +658,7 @@ This upload type is not serializable.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -666,7 +666,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:35 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -265,7 +265,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -311,7 +311,7 @@ parameters and the expected response.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -277,7 +277,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -484,7 +484,7 @@ a tie.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -255,7 +255,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:48 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -293,7 +293,7 @@ Example usage:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -572,7 +572,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:48 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -531,7 +531,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -417,7 +417,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -324,7 +324,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -289,7 +289,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:36 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -421,7 +421,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -324,7 +324,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -291,7 +291,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -311,7 +311,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -431,7 +431,7 @@ ENT_TYPE, UNSUBSCRIBE])
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -168,7 +168,7 @@ The request cannot be subscribed.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -686,7 +686,7 @@ Unsuscribe header value.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -227,7 +227,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:38 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -161,7 +161,7 @@ The constructor takes a discovery document in which to look up named schema.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -427,7 +427,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:48 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -475,7 +475,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:38 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -496,7 +496,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:38 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -52,32 +52,24 @@
|
||||
</b></center><br />
|
||||
<h1 class="epydoc">Class Hierarchy</h1>
|
||||
<ul class="nomargin-top">
|
||||
<li> <strong class="uidlink"><i>unreachable</i></strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><i>unreachable</i></strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><i>unreachable</i></strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><i>unreachable</i></strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">SocketServer.BaseRequestHandler</strong>:
|
||||
<em class="summary">Base class for request handler classes.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">SocketServer.BaseServer</strong>:
|
||||
<em class="summary">Base class for server classes.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.ndb.BlobProperty</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">django.db.models.Field</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">django.db.models.Field</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Model</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Model</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.ndb.Model</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.ndb.Model</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.ndb.PickleProperty</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Property</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Property</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">collections.defaultdict</strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink">object</strong>:
|
||||
@@ -100,7 +92,7 @@
|
||||
<li> <strong class="uidlink"><a href="oauth2client.locked_file.CredentialsFileSymbolicLinkError-class.html">oauth2client.locked_file.CredentialsFileSymbolicLinkError</a></strong>:
|
||||
<em class="summary">Credentials files must not be symbolic links.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.Error-class.html">oauth2client.multistore_file.Error</a></strong>:
|
||||
<li> <strong class="uidlink"><a href="apiclient.errors.Error-class.html">apiclient.errors.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.client.Error-class.html">oauth2client.client.Error</a></strong>:
|
||||
@@ -109,7 +101,7 @@
|
||||
<li> <strong class="uidlink"><a href="oauth2client.clientsecrets.Error-class.html">oauth2client.clientsecrets.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.errors.Error-class.html">apiclient.errors.Error</a></strong>:
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.Error-class.html">oauth2client.multistore_file.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.InvalidClientSecretsError-class.html">oauth2client.appengine.InvalidClientSecretsError</a></strong>:
|
||||
@@ -178,18 +170,27 @@ interpreter exiting.</em>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.client.MemoryCache-class.html">oauth2client.client.MemoryCache</a></strong>:
|
||||
<em class="summary">httplib2 Cache implementation which only caches locally.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Model</strong>:
|
||||
<em class="summary">Model is the superclass of all object entities in the datastore.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.model.Model-class.html">apiclient.model.Model</a></strong>:
|
||||
<em class="summary">Model base class.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.OAuth2Decorator-class.html">oauth2client.appengine.OAuth2Decorator</a></strong>:
|
||||
<em class="summary">Utility for making OAuth 2.0 easier.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.db.Property</strong>:
|
||||
<em class="summary">A Property is an attribute of a Model.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.RequestMockBuilder-class.html">apiclient.http.RequestMockBuilder</a></strong>:
|
||||
<em class="summary">A simple mock of HttpRequest</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.discovery.Resource-class.html">apiclient.discovery.Resource</a></strong>:
|
||||
<li> <strong class="uidlink"><a href="apiclient.discovery.Resource-class.html" onclick="show_private();">apiclient.discovery.Resource</a></strong>:
|
||||
<em class="summary">A class for interacting with a resource.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.discovery.ResourceMethodParameters-class.html" onclick="show_private();">apiclient.discovery.ResourceMethodParameters</a></strong>:
|
||||
<em class="summary">Represents the parameters associated with a method.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.schema.Schemas-class.html">apiclient.schema.Schemas</a></strong>:
|
||||
<em class="summary">Schemas for an API.</em>
|
||||
</li>
|
||||
@@ -211,6 +212,9 @@ interpreter exiting.</em>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http._StreamSlice-class.html" onclick="show_private();">apiclient.http._StreamSlice</a></strong>:
|
||||
<em class="summary">Truncated stream.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">type</strong>:
|
||||
<em class="summary">type(object) -> the object's type...</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -237,7 +241,7 @@ interpreter exiting.</em>
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:29 2013
|
||||
Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:22 2013
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 2.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 2.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.9 KiB After Width: | Height: | Size: 1.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.7 KiB |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user