+ printServers()
+
Returns the printServers Resource.
+ diff --git a/docs/dyn/admin_directory_v1.customers.chrome.printServers.html b/docs/dyn/admin_directory_v1.customers.chrome.printServers.html new file mode 100644 index 00000000000..85cda5bc764 --- /dev/null +++ b/docs/dyn/admin_directory_v1.customers.chrome.printServers.html @@ -0,0 +1,390 @@ + + + +
+ batchCreatePrintServers(parent, body=None, x__xgafv=None)
Creates multiple print servers.
+
+ batchDeletePrintServers(parent, body=None, x__xgafv=None)
Deletes multiple print servers.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a print server.
+ +Deletes a print server.
+ +Returns a print server's configuration.
+ +Lists print server configurations.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a print server's configuration.
+batchCreatePrintServers(parent, body=None, x__xgafv=None)
+ Creates multiple print servers.
+
+Args:
+ parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to add multiple new print servers in a batch.
+ "requests": [ # Required. A list of `PrintServer` resources to be created (max `50` per batch).
+ { # Request for adding a new print server.
+ "parent": "A String", # Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`
+ "printServer": { # Configuration for a print server. # Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/admin-sdk/directory/v1/guides/manage-org-units).
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "failures": [ # A list of create failures. `PrintServer` IDs are not populated, as print servers were not created.
+ { # Info about failures
+ "errorCode": "A String", # Canonical code for why the update failed to apply.
+ "errorMessage": "A String", # Failure reason message.
+ "printServer": { # Configuration for a print server. # Failed print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+ },
+ "printServerId": "A String", # ID of a failed print server.
+ },
+ ],
+ "printServers": [ # A list of successfully created print servers with their IDs populated.
+ { # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+ },
+ ],
+}
+batchDeletePrintServers(parent, body=None, x__xgafv=None)
+ Deletes multiple print servers.
+
+Args:
+ parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to delete multiple existing print servers in a batch.
+ "printServerIds": [ # A list of print server IDs that should be deleted (max `100` per batch).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "failedPrintServers": [ # A list of update failures.
+ { # Info about failures
+ "errorCode": "A String", # Canonical code for why the update failed to apply.
+ "errorMessage": "A String", # Failure reason message.
+ "printServer": { # Configuration for a print server. # Failed print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+ },
+ "printServerId": "A String", # ID of a failed print server.
+ },
+ ],
+ "printServerIds": [ # A list of print server IDs that were successfully deleted.
+ "A String",
+ ],
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a print server.
+
+Args:
+ parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+}
+delete(name, x__xgafv=None)
+ Deletes a print server.
+
+Args:
+ name: string, Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Returns a print server's configuration.
+
+Args:
+ name: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+}
+list(parent, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists print server configurations.
+
+Args:
+ parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
+ filter: string, Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.
+ orderBy: string, Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending "desc" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.
+ orgUnitId: string, If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.
+ pageSize: integer, The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.
+ pageToken: string, A generated token to paginate results (the `next_page_token` from a previous call).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # A token that can be sent as `page_token` in a request to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "printServers": [ # List of print servers.
+ { # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a print server's configuration.
+
+Args:
+ name: string, Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+}
+
+ updateMask: string, The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Configuration for a print server.
+ "createTime": "A String", # Output only. Time when the print server was created.
+ "description": "A String", # Editable. Description of the print server (as shown in the Admin console).
+ "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
+ "id": "A String", # Immutable. ID of the print server. Leave empty when creating.
+ "name": "A String", # Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
+ "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits).
+ "uri": "A String", # Editable. Print server URI.
+}
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the [AdClient resource](https://developers.google.com/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566
Gets an ad unit from a specified account and ad client.
@@ -95,12 +98,55 @@Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
+ Creates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the [AdClient resource](https://developers.google.com/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566
+
+Args:
+ parent: string, Required. Ad client to create an ad unit under. Format: accounts/{account}/adclients/{adclient} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+ "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
+ "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+ "type": "A String", # Required. Type of the ad unit.
+ },
+ "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
+ "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
+ "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+ "state": "A String", # State of the ad unit.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+ "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
+ "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+ "type": "A String", # Required. Type of the ad unit.
+ },
+ "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
+ "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
+ "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+ "state": "A String", # State of the ad unit.
+}
+get(name, x__xgafv=None)
Gets an ad unit from a specified account and ad client. @@ -198,6 +244,7 @@Method Details
{ # Response definition for the custom channels linked to an adunit list rpc. "customChannels": [ # The custom channels returned in this list response. { # Representation of a custom channel. + "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192. "displayName": "A String", # Required. Display name of the custom channel. "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension. @@ -235,4 +282,45 @@Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566
+
+Args:
+ name: string, Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+ "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
+ "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+ "type": "A String", # Required. Type of the ad unit.
+ },
+ "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
+ "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
+ "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+ "state": "A String", # State of the ad unit.
+}
+
+ updateMask: string, The list of fields to update. If empty, a full update is performed.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+ "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
+ "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+ "type": "A String", # Required. Type of the ad unit.
+ },
+ "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
+ "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
+ "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+ "state": "A String", # State of the ad unit.
+}
+