Reference documentation and code samples for the Google Ads Ad Manager V1 Client class User.
The User resource.
Generated from protobuf message google.ads.admanager.v1.User
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the User. Format: |
↳ user_id |
int|string
Output only. |
↳ display_name |
string
Required. The name of the User. It has a maximum length of 128 characters. |
↳ email |
string
Required. The email or login of the User. In order to create a new user, you must already have a Google Account. |
↳ role |
string
Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs. |
↳ active |
bool
Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. |
↳ external_id |
string
Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters. |
↳ service_account |
bool
Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI. |
↳ orders_ui_local_time_zone |
string
Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses. |
getName
Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserId
Output only. User ID.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setUserId
Output only. User ID.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The name of the User. It has a maximum length of 128 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The name of the User. It has a maximum length of 128 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmail
Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEmail
Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRole
Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRole
Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActive
Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setActive
Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExternalId
Optional. An identifier for the User that is meaningful to the publisher.
This attribute has a maximum length of 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setExternalId
Optional. An identifier for the User that is meaningful to the publisher.
This attribute has a maximum length of 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
Output only. Whether the user is an OAuth2 service account user.
Service account users can only be added through the UI.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setServiceAccount
Output only. Whether the user is an OAuth2 service account user.
Service account users can only be added through the UI.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrdersUiLocalTimeZone
Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrdersUiLocalTimeZone
Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|